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 [2015/01/08 14:22]
oej [$sel(name) - Selects]
cookbooks:devel:pseudovariables [2019/11/29 01:22] (current)
jih
Line 1: Line 1:
-====== Kamailio SIP Server ​v4.3.x (devel): Pseudo-Variables ======+{{ :​cookbooks:​devel:​pseudovariables.png?​200|}} 
 +====== Kamailio SIP Server ​v5.4.x (devel): Pseudo-Variables ======
  
 ===== Introduction ===== ===== Introduction =====
Line 9: Line 10:
 There is a set of predefined pseudo-variables,​ which have the name composed from one or more characters, and special pseudo-variables that are references to dynamic fields (AVP and Headers). There is a set of predefined pseudo-variables,​ which have the name composed from one or more characters, and special pseudo-variables that are references to dynamic fields (AVP and Headers).
  
-Pseudo-Variables are implemented by various modules, most of them are provided by **pv**.+Pseudo-Variables are implemented by various modules, most of them are provided by **pv** ​(if there is no special reference to a module, expect that the pseudo-variable is provided by **pv** module).
  
 ===== Pseudo-variables usage ===== ===== Pseudo-variables usage =====
Line 19: Line 20:
   * avpops   * avpops
   * htable   * htable
 +  * http_async_client
   * textops   * textops
   * uac   * uac
Line 75: Line 77:
 **$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 $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 ==== ==== $branch(name) - Branch attributes ====
  
Line 169: Line 173:
 **$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. **$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 ==== ==== $ct - Contact header ====
  
Line 221: Line 228:
  
 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 230: Line 238:
  
 To reset $du: To reset $du:
-  $du = null;+  $du = $null;
  
 ==== $fd - From URI domain ==== ==== $fd - From URI domain ====
Line 250: Line 258:
 **$ft** - reference to tag parameter of '​From'​ header **$ft** - reference to tag parameter of '​From'​ header
  
 +==== $fti - Initial From tag ====
 +
 +**$fti** - reference to tag parameter of '​From'​ header as it was in the initial request (e.g., initial INVITE).
 +
 +The value From tag in the initial request can be in the To tag, if the request within the dialog is sent by the callee. This variable detect who sent the request within the dialog and returns the proper value that was in the From tag of the request initiating the dialog.
 +
 +It is exported by **rr** module and has to be used after loose_route(). The append_fromtag parameter is required to be set to 1 in order to have this variable returning the right value.
 ==== $fu - From URI ==== ==== $fu - From URI ====
  
Line 267: Line 282:
  
 **$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 325: Line 344:
 **$pp** - reference to process id (pid) **$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 ====
  
-**$pr** or **$proto** - protocol ​of received message (UDP, TCP, TLS, SCTP, WS, WSS)+**$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 ==== ==== $pU - User in P-Preferred-Identity header URI ====
  
Line 337: Line 368:
 **$pu** - reference to URI in request'​s P-Preferred-Identity header (see RFC 3325) **$pu** - reference to URI in request'​s P-Preferred-Identity header (see RFC 3325)
  
-==== $rd - Domain in R-URI ==== 
  
-**$rd** - reference to domain in request'​s URI (without port) or to the Namespace Specific String of a URN (see RFC 2141) 
- 
-<fc #​0000ff>​It is R/W variable (you can assign values to it directly in configuration file)</​fc>​ 
  
 ==== $rb - Body of request/​reply ==== ==== $rb - Body of request/​reply ====
Line 353: Line 380:
 **$retcode** - same as **$rc** **$retcode** - same as **$rc**
  
 +==== $rd - Domain in R-URI ====
 +
 +**$rd** - reference to domain in request'​s URI (without port) or to the Namespace Specific String of a URN (see RFC 2141)
 +
 +<fc #​0000ff>​It is R/W variable (you can assign values to it directly in configuration file)</​fc>​
 +
 +==== $rdir(key) - Request Direction ====
 +
 +**$rdir(key)** - get the direction of the request within dialog.
 +
 +The direction is '​downstream'​ if sent by the caller and '​upstream'​ if sent by callee.
 +
 +The key can be:
 +
 +  * id - the returned value is an integer: 1 - for direction downstream, 2 - for direction upstream
 +  * name - the returned value is a string: '​downstream'​ or '​upstream'​
 +
 +Example:
 +
 +<code c>
 +if($rdir(name)=="​upstream"​) {
 +  xlog("​request was sent by callee\n"​);​
 +}
 +</​code>​
 +
 +The variable is exported by **rr** module and append_fromtag parameter must be enabled. The variable has to be used after loose_route() function.
 ==== $re - Remote-Party-ID header URI ==== ==== $re - Remote-Party-ID header URI ====
  
Line 403: Line 456:
 <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>​
  
 +==== $rv - SIP message version ====
 +
 +**$rv** - reference to SIP message (reply or request) version
 ==== $ruid - Record internal Unique ID ==== ==== $ruid - Record internal Unique ID ====
  
Line 410: Line 466:
  
 **$rz** - returns R-URI scheme, possible values: sip, sips, tel, tels and urn, R-URI scheme parsing error should be reflected by value: none **$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 - Received IP address ====
  
 **$Ri** - reference to IP address of the interface where the request has been received **$Ri** - reference to IP address of the interface where the request has been received
- 
 ==== $Rp - Received port ==== ==== $Rp - Received port ====
  
 **$Rp** - reference to the port where the message was received **$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 ====
 +
 +**$sbranch(attr)** - class of variables allowing to manage the values of attributes for static branch. The static branch is internal structure that is used by the functions sbranch_push_ruri() and sbranch_append() from **pv** module, enabling more flexibility in updating the R-URI (first) branch attributes as well as extra branches (e.g., for parallel forking).
 +
 +The **attr** can be any of the supported values for **$branch(attr)** class of variables -- see above for proper details.
 +
 +Example of usage:
 +
 +<code c>
 +sbranch_reset();​
 +$sbranch(uri) = "​sip:​127.0.0.1:​5080";​
 +$sbranch(dst_uri) =  "​sip:​127.0.0.1:​5090";​
 +$sbranch(path) =  "​sip:​127.0.0.1:​5090,​ sip:​127.0.0.1:​5094";​
 +$sbranch(send_socket) =  "​udp:​127.0.0.1:​5060";​
 +sbranch_set_ruri();​
 +</​code>​
  
 ==== $sf - Script flags ==== ==== $sf - Script flags ====
Line 429: Line 528:
 ==== $si - Source IP address ==== ==== $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 ==== ==== $sp - Source port ====
Line 439: Line 545:
 **$stat(name)** - return the value of statistic item specified by '​name'​ **$stat(name)** - return the value of statistic item specified by '​name'​
  
 +==== $su - Source address as URI ====
 +
 +
 +**$su** - returns the representation of source address (ip, port, proto) as SIP URI. If the proto is UDP, then it is not added (being the default transport protocol).
 +
 +Its value looks like:
 +
 +<​code>​
 +"​sip:​ip:​port"​ -- if proto is UDP
 +"​sip:​ip:​port;​transport=proto" ​ -- if proto is not UDP
 +</​code>​
 +
 +Note that WS and WSS are both represented by transport=ws,​ conforming with the IETF RFC for SIP over WebSocket.
 +
 +==== $sut - Source address as full URI ====
 +
 +**$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:
 +
 +<​code>​
 +"​sip:​ip:​port;​transport=proto"​
 +</​code>​
 ==== $td - To URI Domain ==== ==== $td - To URI Domain ====
  
Line 451: Line 580:
 **$tt** - reference to tag parameter of '​To'​ header **$tt** - reference to tag parameter of '​To'​ header
  
 +==== $tti - Initial To tag ====
 +
 +**$tti** - reference to tag parameter of '​To'​ header as it was in the SIP response to the initial request (e.g., 200ok to the initial INVITE).
 +
 +The value To tag in the initial transaction can be in the From tag, if the request within the dialog is sent by the callee. This variable detect who sent the request within the dialog and returns the proper value that was in the To tag of the transaction initiating the dialog.
 +
 +It is exported by **rr** module and has to be used after loose_route(). The append_fromtag parameter is required to be set to 1 in order to have this variable returning the right value.
 ==== $tu - To URI ==== ==== $tu - To URI ====
  
Line 490: Line 626:
  
 **$ua** - reference to user agent header field **$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 =====
 +
 +**$env(NAME)** - value of the environment variable named NAME
  
 ===== $avp(id) - AVPs ===== ===== $avp(id) - AVPs =====
Line 537: Line 685:
  
 It is R/W variable (you can assign values to it directly in configuration file). It is R/W variable (you can assign values to it directly in configuration file).
 +
 +===== $expires(key) - Expires Values =====
 +
 +Return the min and max of expires value for current SIP message. Contact headers are checked with higher priority, if no expires parameter there, then Expires header is used
 +
 +If none is found, $null is returned.
 +
 +Possible '​key'​ values:
 +
 +  * $expires(min) - the minimum value for expires
 +  * $expires(max) - the maximum value for expires
 +
 +When there is only one expires value, then min and max return the same.
 +
 +Example of usage:
 +
 +<code c>
 +if($expires(max)!=$null) {
 +    xlog("​max expires value is: $expires(max)\n"​);​
 +}
 +</​code>​
  
 ===== $xavp(id) - XAVPs ===== ===== $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 '=>' ​like $xavp(root=>​branch) where "​root"​ is the name of the structure and branch is a named value. To assign a value use+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
 <code c> <code c>
 $xavp(root=>​branch)="​value";​ $xavp(root=>​branch)="​value";​
Line 593: Line 762:
 **$(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 606: Line 777:
  
 <fc #​0000ff>​It is read-only variable. You can remove or add headers using functions from textops module.</​fc>​ <fc #​0000ff>​It is read-only variable. You can remove or add headers using functions from textops module.</​fc>​
 +
 +===== $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>​
  
 ===== $var(name) - Private memory variables (zero) ===== ===== $var(name) - Private memory variables (zero) =====
Line 658: Line 841:
 ===== $shv(name) - Shared memory variables ===== ===== $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 openser ​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: Example - shv(name) pseudo-variable usage:
Line 674: Line 857:
 <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 =====
  
-**$time(name)** - the PV provides access to broken-down time attributes.+**$time(name)** - the PV provides access to broken-down time attributes ​in the local timezone.
  
 The '​name'​ can be: The '​name'​ can be:
Line 699: Line 891:
 </​code>​ </​code>​
  
 +===== $utime(name) - Broken-down time =====
  
 +**$utime(name)** - the PV provides access to broken-down time attributes in UTC.
 +
 +See **$time(name)** above for the possible attributes
 ===== $timef(format) - Strftime Formatted Time ===== ===== $timef(format) - Strftime Formatted Time =====
  
Line 708: Line 904:
 <code c> <code c>
 xlog("​Today is $timef(%m/​%d/​%y)\n"​);​ xlog("​Today is $timef(%m/​%d/​%y)\n"​);​
 +</​code>​
 +
 +===== $utimef(format) - Strftime Formatted UTC Time =====
 +
 +**$utimef(format)** - return current time in UTC as formatted by strftime '​format'​. See 'man strftime'​ to see the available time attribute specifiers.
 +
 +Example:
 +
 +<code c>
 +xlog("​The time is $utimef(%m/​%d/​%y %H:​%M:​%S)\n"​);​
 </​code>​ </​code>​
  
Line 726: Line 932:
 } }
 </​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 745: Line 977:
   * 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)
   * buf - entire send buffer as string   * buf - entire send buffer as string
   * len - length of outgoing packet (length of above buf)   * len - length of outgoing packet (length of above buf)
Line 802: Line 1035:
 Return the attribute of the context for current processed dialog. Return the attribute of the context for current processed dialog.
  
-<fc #0000ff>It is R/W variable.</​fc>​+<fc #0000ff>Some of the attributes are R/W variables.</​fc>​
  
 The '​attr'​ can be: The '​attr'​ can be:
-  * set +  * set - returns 1 if the dialog for current context is set, 0 otherwise 
-  * flags +  * flags - get/set dialog ​flags 
-  * timeout_route +  * timeout_route ​- get/set route name to be executed on timeout 
-  * timeout_bye+  * timeout_route_id - get internal id for the route to be executed on timeout 
 +  * timeout_bye ​- set to 1 if BYE has to be sent when dialog lifetime elapses 
 +  * timeout - set the dialog lifetime (in seconds) 
 +  * on - get/set an integer value associated with the context (cfg usage) 
 +  * dir - get direction of the request for the dialog of the current context (0 - unknown, 1 - downstream, 2 - upstream)
  
 ==== $dlg_var(key) ==== ==== $dlg_var(key) ====
Line 817: Line 1054:
  
 The '​key'​ can be any string. The '​key'​ can be any string.
 +
 +===== Erlang module Pseudo-Variables =====
 +
 +==== Erlang pseudo-variable attributes ===
 +
 +* type - get variable type. Possible types are: atom, integer, list, string, tuple, pid and ref.
 +
 +* length - get length of list or tuple.
 +
 +* format - prints a term, in clear text. It tries to resemble the term printing in the Erlang shell.
 +
 +==== $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
 +atom could be enclosed in single quotes (') if it does not begin with a 
 +lower-case letter or if it contains other characters than alphanumeric characters,
 +underscore (_), or @.
 +
 +Example:
 +
 +<code c>
 +$erl_atom(A) = "​node@host.tld";​
 +
 +xlogl("​L_DEBUG","​$$erl_atom(A):​ $erl_atom(A=>​format)\n"​);​
 +</​code>​
 +
 +==== $erl_list(name) ====
 +Compound data type with a variable number of terms. Formally, a list is either
 +the empty list [] or consists of one or more elements.
 +
 +Example:
 +
 +<code c>
 +$erl_atom(E) = "​example";​
 +$erl_list(L) = "​list";​
 +$erl_list(L) = "​of";​
 +$erl_list(L) = $erl_atom(E);​
 +
 +xlogl("​L_DEBUG","​length(L):​ $erl_list(L=>​length),​ format(L): $erl_list(L=>​format)\n"​);​
 +
 +# empty list
 +$erl_tuple(E[*]) = $null;
 +</​code>​
 +
 +==== $erl_tuple(name) ====
 +From the Erlang point of view the tuple compound data type with a fixed number
 +of terms. The module implementation of tuple has the same behavior as the list.
 +
 +Example:
 +
 +<code c>
 +$erl_atom(e) = "​error";​
 +
 +$erl_tuple(T) = "​badrpc";​
 +$erl_tuple(T) = $erl_atom(e);​
 +
 +xlogl("​L_DEBUG","​length(T):​ $erl_tuple(T=>​length),​ format(T): $erl_tuple(T=>​format)\n"​);​
 +</​code>​
 +
 +==== $erl_pid(name) ====
 +Holds Eralng process identifier. Provides access to Erlang PID value and could
 +be used in send message.
 +
 +==== $erl_ref(name) ====
 +Holds Erlang reference. Provides access to reference value and could be used in
 +send message.
 +
 +==== $erl_xbuff(name) ====
 +Generic pseudo variable to acts as other pseudo variables exported from Erlang
 +module.
  
 ===== HTable module Pseudo-Variables ===== ===== HTable module Pseudo-Variables =====
Line 824: Line 1131:
 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.</​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 935: Line 1242:
 xlog("​==== $shtdec(a=>​$au)\n"​);​ xlog("​==== $shtdec(a=>​$au)\n"​);​
 ... ...
 +</​code>​
 +
 +==== $shtitkey(iname) ====
 +
 +The key at the current position in the iterator.
 +
 +==== $shtitval(iname) ====
 +
 +The value at the current position in the iterator.
 +
 +Example:
 +
 +<code c>
 +    sht_iterator_start("​i1",​ "​h1"​);​
 +    while(sht_iterator_next("​i1"​)) {
 +        xlog("​h1[$shtitkey(i1)] is: $shtitval(i1)\n"​);​
 +    }
 +    sht_iterator_end("​i1"​);​
 +</​code>​
 +
 +==== $shtrecord(id) ====
 +
 +Get the key or the value of expired item inside the event_route[htable:​expired:​_table_name_].
 +
 +The id can be:
 +
 +  * key
 +  * value
 +
 +Example:
 +
 +<code c>
 +event_route[htable:​expired:​h1] {
 +  xlog("​expired item ($shtrecord(key),​$shtrecord(value))\n"​);​
 +}
 </​code>​ </​code>​
 ===== Memcached module Pseudo-Variables ===== ===== Memcached module Pseudo-Variables =====
Line 1012: Line 1354:
 ... ...
 </​code>​ </​code>​
 +
 +===== http_async_client module Pseudo-Variables =====
 +
 +==== $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 1096: Line 1496:
 The **name** can be: 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   * reply_type - 1 if it is a local generated reply, 0 - if no reply for transaction or it is a received reply
  
Line 1120: Line 1525:
   * used to build the input for uac_send_req() function of UAC module   * used to build the input for uac_send_req() function of UAC module
  
-key can be:+The key can be:
   * method - SIP method   * method - SIP method
   * ruri - request URI   * ruri - request URI
Line 1131: Line 1536:
   * apasswd - authentication password   * apasswd - authentication password
   * sock - local socket to be used for sending (proto:​address:​port)   * sock - local socket to be used for sending (proto:​address:​port)
 +  * callid - SIP-Call-ID of the generated request (by default, a call-id is generated)
   * all - alias useful to reset all fields - $uac_req(all) = $null;   * all - alias useful to reset all fields - $uac_req(all) = $null;
 +  * evroute - it has to be set to 1 in order to execute event_route[uac:​reply] when reply is received
 +  * evcode - reply code for the request sent with uac_req_send(),​ available inside event_route[uac:​reply]
 +  * evtype - is 1 if the reply was received via network, 2 if the reply was locally generated (e.g., retransmission timeout), available inside event_route[uac:​reply]
 +  * evparam - generic data buffer associated with the request that can be set before sending it and retrieved when executing the event route. It has a size of 128 characters.
  
 <code c> <code c>
Line 1138: Line 1548:
 $uac_req(furi)="​sip:​kamailio.org";​ $uac_req(furi)="​sip:​kamailio.org";​
 $uac_req(turi)="​sip:​kamailio.org";​ $uac_req(turi)="​sip:​kamailio.org";​
 +$uac_req(evroute) = 1;
 uac_req_send();​ uac_req_send();​
 +...
 +event_route[uac:​reply] {
 +  xlog("​request sent to $uac_req(ruri) completed with code: $uac_req(evcode)\n"​);​
 +}
 </​code>​ </​code>​
 ===== Nathelper module Pseudo-Variables ===== ===== Nathelper module Pseudo-Variables =====
Line 1176: Line 1591:
 ==== $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 1196: Line 1610:
   * $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 1217: Line 1683:
   * regn - region name   * regn - region name
   * metro - metro code   * 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. 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.
Line 1234: Line 1701:
  
 ==== $tls_version ==== ==== $tls_version ====
 +The TLS/SSL version which is used on the TLS connection from which the message was received. String type.
 ==== $tls_description ==== ==== $tls_description ====
 +The TLS/SSL description of the TLS connection from which the message was received. String type.
 ==== $tls_cipher_info ==== ==== $tls_cipher_info ====
 +The TLS/SSL cipher which is used on the TLS connection from which the message was received. String type.
 ==== $tls_cipher_bits ==== ==== $tls_cipher_bits ====
 +The number of cipher bits which are used on the TLS connection from which the message was received. String and Integer type.
 ==== $tls_peer_version ==== ==== $tls_peer_version ====
 +The version of the certificate. String type.
 ==== $tls_my_version ==== ==== $tls_my_version ====
 +The version of the certificate. String type.
 ==== $tls_peer_serial ==== ==== $tls_peer_serial ====
 +The serial number of the certificate. String and Integer type.
 ==== $tls_my_serial ==== ==== $tls_my_serial ====
 +The serial number of the certificate. String and Integer type.
 ==== $tls_peer_subject ==== ==== $tls_peer_subject ====
 +ASCII dump of the fields in the subject section of the certificate. String type. Example:
 +    /​C=AT/​ST=Vienna/​L=Vienna/​O=enum.at/​CN=enum.at
 ==== $tls_peer_issuer ==== ==== $tls_peer_issuer ====
 +ASCII dump of the fields in the issuer section of the certificate. String type.
 ==== $tls_my_subject ==== ==== $tls_my_subject ====
 +ASCII dump of the fields in the subject section of the certificate. String type.
 ==== $tls_my_issuer ==== ==== $tls_my_issuer ====
 +ASCII dump of the fields in the issuer section of the certificate. String type.
 ==== $tls_peer_subject_cn ==== ==== $tls_peer_subject_cn ====
 +commonName in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_cn ==== ==== $tls_peer_issuer_cn ====
 +commonName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_cn ==== ==== $tls_my_subject_cn ====
 +commonName in the subject section of the certificate. String type.
 ==== $tls_my_issuer_cn ==== ==== $tls_my_issuer_cn ====
 +commonName in the issuer section of the certificate. String type.
 ==== $tls_peer_subject_locality ==== ==== $tls_peer_subject_locality ====
 +localityName in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_locality ==== ==== $tls_peer_issuer_locality ====
 +localityName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_locality ==== ==== $tls_my_subject_locality ====
 +localityName in the subject section of the certificate. String type.
 ==== $tls_my_issuer_locality ==== ==== $tls_my_issuer_locality ====
 +localityName in the issuer section of the certificate. String type.
 ==== $tls_peer_subject_country ==== ==== $tls_peer_subject_country ====
 +countryName in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_country ==== ==== $tls_peer_issuer_country ====
 +countryName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_country ==== ==== $tls_my_subject_country ====
 +countryName in the subject section of the certificate. String type.
 ==== $tls_my_issuer_country ==== ==== $tls_my_issuer_country ====
 +countryName in the issuer section of the certificate. String type.
 ==== $tls_peer_subject_state ==== ==== $tls_peer_subject_state ====
 +stateOrProvinceName in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_state ==== ==== $tls_peer_issuer_state ====
 +stateOrProvinceName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_state ==== ==== $tls_my_subject_state ====
 +stateOrProvinceName in the subject section of the certificate. String type.
 ==== $tls_my_issuer_state ==== ==== $tls_my_issuer_state ====
 +stateOrProvinceName in the issuer section of the certificate. String type.
 ==== $tls_peer_subject_organization ==== ==== $tls_peer_subject_organization ====
 +organizationName in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_organization ==== ==== $tls_peer_issuer_organization ====
 +organizationName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_organization ==== ==== $tls_my_subject_organization ====
 +organizationName in the subject section of the certificate. String type.
 ==== $tls_my_issuer_organization ==== ==== $tls_my_issuer_organization ====
 +organizationName in the issuer section of the certificate. String type.
 ==== $tls_peer_subject_unit ==== ==== $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 ==== ==== $tls_peer_issuer_unit ====
 +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.
 +==== $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.
 ==== $tls_peer_san_email ==== ==== $tls_peer_san_email ====
 +email address in the "​subject alternative name" extension. String type.
 ==== $tls_my_san_email ==== ==== $tls_my_san_email ====
 +email address in the "​subject alternative name" extension. String type.
 ==== $tls_peer_san_hostname ==== ==== $tls_peer_san_hostname ====
 +hostname (DNS) in the "​subject alternative name" extension. String type.
 ==== $tls_my_san_hostname ==== ==== $tls_my_san_hostname ====
 +hostname (DNS) in the "​subject alternative name" extension. String type.
 ==== $tls_peer_san_uri ==== ==== $tls_peer_san_uri ====
 +URI in the "​subject alternative name" extension. String type.
 ==== $tls_my_san_uri ==== ==== $tls_my_san_uri ====
 +URI in the "​subject alternative name" extension. String type.
 ==== $tls_peer_san_ip ==== ==== $tls_peer_san_ip ====
 +ip address in the "​subject alternative name" extension. String type.
 ==== $tls_my_san_ip ==== ==== $tls_my_san_ip ====
 +ip address in the "​subject alternative name" extension. String type.
 +
 +==== $tls_peer_verified ====
 +Returns 1 if the peer's certificate was successfully verified. Otherwise it returns 0. String and Integer type.
 +
 +==== $tls_peer_revoked ====
 +Returns 1 if the peer's certificate was revoked. Otherwise it returns 0. String and Integer type.
 +
 +==== $tls_peer_expired ====
 +Returns 1 if the peer's certificate is expired. Otherwise it returns 0. String and Integer type.
 +
 +==== $tls_peer_selfsigned ====
 +Returns 1 if the peer's certificate is selfsigned. Otherwise it returns 0. String and Integer type.
 +
 +==== $tls_peer_notBefore ====
 +Returns the notBefore validity date of the peer's certificate. String type.
 +
 +==== $tls_peer_notAfter ====
 +Returns the notAfter validity date of the peer's certificate. String type.
 +
 +==== $tls_peer_server_name ====
 +The SNI server name of the peer
 +===== SIP Message Attributes =====
 +
 +==== $msg(attr) ====
 +
 +Return attributes of SIP message:
 +
 +  * $msg(len) - sip message length
 +  * $msg(buf) - sip message buffer
 +  * $msg(body) - sip message body
 +  * $msg(body_len) - sip message body length
 +  * $msg(hdrs) - sip message headers
 +  * $msg(fline) - sip message first line
  
 ===== XHTTP module Pseudo-Variables ===== ===== XHTTP module Pseudo-Variables =====
Line 1357: Line 1906:
 ==== $sipt(calling_party_number.presentation) / $sipt_presentation ==== ==== $sipt(calling_party_number.presentation) / $sipt_presentation ====
 Returns the value of the Address presentation restricted indicator contained in the Calling Party Number header of the IAM message if it exists. Returns -1 if there isn't a Calling Party Number header. Returns the value of the Address presentation restricted indicator contained in the Calling Party Number header of the IAM message if it exists. Returns -1 if there isn't a Calling Party Number header.
 +
 +The following values can be returned:
 +  * 0 presentation allowed
 +  * 1 resentation restricted
 +  * 2 address not avail (national use)
 +  * 3 spare
 +
 +Example:
 +
 +<code c>
 +if($sipt(calling_party_number.presentation) == 1)
 +{
 +        append_hf("​Privacy:​ id\r\n"​);​
 +        $fn = "​Anonymous";​
 +}
 +</​code>​
 +
  
 ==== $sipt(calling_party_number.screening) / $sipt_screening ==== ==== $sipt(calling_party_number.screening) / $sipt_screening ====
 Returns the value of the Screening Indicator contained in the Calling Party Number header of the IAM message if it exists. Returns -1 if there isn't a Calling Party Number header. Returns the value of the Screening Indicator contained in the Calling Party Number header of the IAM message if it exists. Returns -1 if there isn't a Calling Party Number header.
 +
 +Can return the following values:
 +  * 0 Reserved (user provided, not verified)
 +  * 1 User Provided, Verified and Passed
 +  * 2 Reserved (user provided, verified and failed)
 +  * 3 Network provided
 +
 +Example:
 +<code c>
 +# remove P-Asserted-Identity header if the screening isn't verified
 +# or network provided
 +$avp(s:​screening) = $sipt(calling_party_number.screening);​
 +if($avp(s:​screening) != 1 && $avp(s:​screening) != 3)
 +{
 +        remove_hf("​P-Asserted-Id"​);​
 +}
 +</​code>​
 +
  
 ====  $sipt(hop_counter) / $sipt_hop_counter ==== ====  $sipt(hop_counter) / $sipt_hop_counter ====
 Returns the value of the Hop Counter for the IAM message if it exists. Returns -1 if there isn't a hop counter. Returns the value of the Hop Counter for the IAM message if it exists. Returns -1 if there isn't a hop counter.
 +
 +Example:
 +<code c>
 +# get the hop counter and update the Max-Forwards header if it exists
 +$avp(s:hop) = $sipt(hop_counter);​
 +if($avp(s:​hop) > 0)
 +{
 +        remove_hf("​Max-Forwards"​);​
 +        append_hf("​Max-Forwards:​ $avp(s:​hop)\r\n"​);​
 +}
 +</​code>​
  
 ==== $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc ==== ==== $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc ====
Line 1369: Line 1964:
 ==== $sipt(calling_party_number.nature_of_address) / $sipt.(calling_party_number.nai) / $sipt_calling_party_nai ==== ==== $sipt(calling_party_number.nature_of_address) / $sipt.(calling_party_number.nai) / $sipt_calling_party_nai ====
 Returns the value of the Nature of Address Indicator 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. Returns the value of the Nature of Address Indicator 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.
 +
 +Can return the following values:
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number (national use)
 +  * 4 International use
 +
 +Example:
 +<code c>
 +# get the Calling Nai and add country code if national
 +if($sipt(calling_party_number.nai) == 3)
 +{
 +        $fU = "​32"​ + "​$fU";​
 +}
 +</​code>​
  
 ====  $sipt(called_party_number.nature_of_address) / $sipt(called_party_number.nai) / $sipt_called_party_nai ==== ====  $sipt(called_party_number.nature_of_address) / $sipt(called_party_number.nai) / $sipt_called_party_nai ====
 Returns the value of the Nature of Address Indicator of the Called Party for the IAM message. Returns -1 if there is a parsing error. Returns the value of the Nature of Address Indicator of the Called Party for the IAM message. Returns -1 if there is a parsing error.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +  * 5 Network-specific number (national use)
 +
 +Example:
 +<code c>
 +# get the Called Nai and add country code if national
 +if($sipt(called_party_number.nai) == 3)
 +{
 +        $rU = "​32"​ + "​$rU";​
 +}
 +</​code>​
  
 ==== $sipt(event_info) === ==== $sipt(event_info) ===
 Returns the value  of the Event Info header of the CPG message. Returns -1 if there is a parsing error. Returns the value  of the Event Info header of the CPG message. Returns -1 if there is a parsing error.
 +
 +Can return the following values:
 +  * 0 Spare
 +  * 1 ALERTING
 +  * 2 PROGRESS
 +  * 3 In-band information or an appropriate pattern is now available
 +  * 4 Call forward on busy
 +  * 5 Call forward on no reply
 +  * 6 Call forward unconditional
 +
 +
 +==== $sipt(backward_call_indicator.charge_indicator) ===
 +Returns the value of the charge indication of the backward call
 +indicator header in the ACM or COT message. Returns -1 if there is a
 +parsing error
 +
 +Can return the following values:
 +  * 0 no indication
 +  * 1 no charge
 +  * 2 charge
 +  * 3 spare
 +
  
 ===== $cfg(key) - Config File Attributes ===== ===== $cfg(key) - Config File Attributes =====
Line 1382: Line 2033:
 The key can be: 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: Example:
Line 1390: Line 2043:
 send_reply("​404",​ "Not found at line $cfg(line)"​);​ send_reply("​404",​ "Not found at line $cfg(line)"​);​
 </​code>​ </​code>​
 +
 ===== $dns(pvid=>​key) - DNS Query Result ===== ===== $dns(pvid=>​key) - DNS Query Result =====
  
Line 1432: Line 2086:
 xlog("​local hostanme is $HN(n)\n"​);​ xlog("​local hostanme is $HN(n)\n"​);​
 </​code>​ </​code>​
-===== $C(xy) - Foreground and background colors ===== 
  
 +===== $RANDOM - Random number =====
 +
 +Returns a random value from the [0 - 2^31) range.
 +
 +(Part of the cfgutils module)
 +
 +<code c>
 +if (rand_event()) {
 +  $avp(i:10) = ($RANDOM / 16777216); # 2^24
 +  if ($avp(i:10) < 10) {
 +     ​$avp(i:​10) = 10;
 +  }
 +  append_to_reply("​Retry-After:​ $avp(i:​10)\n"​);​
 +  sl_send_reply("​503",​ "Try later"​);​
 +  exit;
 +};
 +# normal message processing follows
 +</​code>​
 +
 +===== JSONRPCS Variables =====
 +
 +==== $jsonrpl(key) - JSONRPC Reply ====
 +
 +This variable gives access to JSONRPC reply after executing jsonrpc_exec(...) in kamailio.cfg.
 +
 +The key can be:
 +  * code - code for the JSONRPC response
 +  * text - text of the code for the JSONRPC response
 +  * body - the body of the JSONRPC response
 +
 +===== Presence Module Pseudo-Variables =====
 +
 +==== $subs(key) - Subscription Attributes ====
 +
 +This variable gives access to attributes of the current subscription. The variable has to be used after executing //​handle_subscription()//​ in order to provide accurate values.
 +
 +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.
 +
 +===== Registrar Module Pseudo-Variables =====
 +
 +==== $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 Pseudo-Variables =====
 +
 +==== $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
 +
 +===== $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
 +
 +===== $C(xy) - Foreground and background colors =====
  
 $C(xy) - reference to an escape sequence. “x” represents the foreground color and “y” represents the background color. $C(xy) - reference to an escape sequence. “x” represents the foreground color and “y” represents the background color.
cookbooks/devel/pseudovariables.1420723338.txt.gz · Last modified: 2015/01/08 14:22 by oej