This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
cookbooks:devel:pseudovariables [2016/02/23 09:32] tsearle updated sipt variable descriptions |
cookbooks:devel:pseudovariables [2021/06/08 13:37] miconda [$hfl(name) - Header Field With List Of Bodies] |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Pseudo-Variables ====== | ||
+ | |||
+ | Version: Kamailio SIP Server v5.6.x (devel) | ||
+ | |||
{{ : | {{ : | ||
- | ====== Kamailio SIP Server v4.4.x (devel): Pseudo-Variables ====== | ||
===== Introduction ===== | ===== Introduction ===== | ||
Line 20: | Line 23: | ||
* avpops | * avpops | ||
* htable | * htable | ||
+ | * http_async_client | ||
* textops | * textops | ||
* uac | * uac | ||
Line 76: | Line 80: | ||
**$aU** - whole username from Authorization or Proxy-Authorization header | **$aU** - whole username from Authorization or Proxy-Authorization header | ||
- | ==== $Au - Acc username ==== | + | ==== $Au - Acc username |
- | **$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username | + | **$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns |
+ | ==== $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 170: | Line 176: | ||
**$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 187: | Line 196: | ||
**$dd** - reference to domain of destination uri (without port) | **$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(" | ||
+ | </ | ||
+ | |||
+ | ==== $defn(name) - Defined Value As Number ==== | ||
+ | |||
+ | **$defn(name)** - return a defined value as a signed integer. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | #!define FLT_ACC 1 | ||
+ | |||
+ | xlog(" | ||
+ | </ | ||
==== $di - Diversion header URI ==== | ==== $di - Diversion header URI ==== | ||
Line 222: | Line 253: | ||
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 ' | + | $du is also set if lookup() function of ' |
- | 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. | ||
| | ||
| | ||
Line 231: | Line 263: | ||
To reset $du: | To reset $du: | ||
- | $du = null; | + | $du = $null; |
==== $fd - From URI domain ==== | ==== $fd - From URI domain ==== | ||
**$fd** - reference to domain in URI of ' | **$fd** - reference to domain in URI of ' | ||
+ | |||
+ | <fc # | ||
==== $fn - From display name ==== | ==== $fn - From display name ==== | ||
Line 241: | Line 275: | ||
**$fn** - reference to display name of ' | **$fn** - reference to display name of ' | ||
- | ==== $fs - Forced | + | ==== $fs - Forced |
- | **$fs** - reference to the forced socket for message | + | **$fs** - reference to the forced |
<fc # | <fc # | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | listen=udp: | ||
+ | ... | ||
+ | $fs = " | ||
+ | </ | ||
+ | |||
+ | ==== $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: | ||
+ | ... | ||
+ | $fsn = " | ||
+ | ... | ||
+ | $fs = " | ||
+ | xdbg(" | ||
+ | </ | ||
==== $ft - From tag ==== | ==== $ft - From tag ==== | ||
Line 265: | Line 320: | ||
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 272: | Line 328: | ||
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 320: | Line 385: | ||
**$oU** - reference to username in request' | **$oU** - reference to username in request' | ||
+ | |||
+ | ==== $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 333: | Line 402: | ||
**$pp** - reference to process id (pid) | **$pp** - reference to process id (pid) | ||
- | ==== $pr - Protocol of received message ==== | + | ==== $pr or $proto |
**$pr** or **$proto** - protocol of received message (udp, tcp, tls, sctp, ws, wss) | **$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 ==== | ==== $pU - User in P-Preferred-Identity header URI ==== | ||
Line 357: | Line 438: | ||
**$retcode** - same as **$rc** | **$retcode** - same as **$rc** | ||
+ | Note that the value of $rc is overwritten by each new function call. | ||
+ | |||
+ | Example of use: | ||
+ | |||
+ | <code c> | ||
+ | lookup(" | ||
+ | $var(rc) = $rc; | ||
+ | if ($var(rc) < 0) { | ||
+ | t_newtran(); | ||
+ | switch ($var(rc)) { | ||
+ | case -1: | ||
+ | case -3: | ||
+ | send_reply(" | ||
+ | exit; | ||
+ | case -2: | ||
+ | send_reply(" | ||
+ | exit; | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
==== $rd - Domain in R-URI ==== | ==== $rd - Domain in R-URI ==== | ||
Line 433: | Line 535: | ||
<fc # | <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 ==== | ==== $ruid - Record internal Unique ID ==== | ||
Line 440: | Line 549: | ||
**$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: | ||
==== $sbranch(attr) - Static Branch ==== | ==== $sbranch(attr) - Static Branch ==== | ||
Line 476: | Line 611: | ||
==== $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 |
+ | |||
+ | ==== $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 502: | Line 644: | ||
==== $sut - Source address as full URI ==== | ==== $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: | Its value looks like: | ||
Line 535: | Line 677: | ||
**$tU** - reference to username in URI of ' | **$tU** - reference to username in URI of ' | ||
+ | |||
+ | ==== $tUl - To URI Username Length ==== | ||
+ | |||
+ | **$tU** - the length of the username in To URI | ||
==== $Tb - Startup timestamp ==== | ==== $Tb - Startup timestamp ==== | ||
Line 568: | Line 714: | ||
**$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/ | ||
+ | |||
+ | **$version(hash)** - TBA | ||
+ | |||
+ | ===== $env(NAME) - environment variables ===== | ||
+ | |||
+ | **$env(NAME)** - value of the environment variable named NAME | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | xdbg(" | ||
+ | </ | ||
===== $avp(id) - AVPs ===== | ===== $avp(id) - AVPs ===== | ||
Line 638: | Line 801: | ||
===== $xavp(id) - XAVPs ===== | ===== $xavp(id) - XAVPs ===== | ||
- | xavp - extended AVP' | + | **xavp** - eXtended AVPs - are variables |
+ | |||
+ | They work like a stack, | ||
+ | |||
+ | Each xavp has a string | ||
+ | |||
+ | To assign a single | ||
<code c> | <code c> | ||
- | $xavp(root=> | + | $xavp(root)=" |
+ | $xavp(root)=intnumber; | ||
+ | </code> | ||
+ | |||
+ | To assign a named value use: | ||
+ | |||
+ | <code c> | ||
+ | $xavp(root=> | ||
+ | $xavp(root=> | ||
</ | </ | ||
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]=> | + | $xavp(root[0]=> |
</ | </ | ||
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 = " |
- | #create | + | $xavp(person=>lastname)="Smith"; |
- | $xavp(example=>name)="two"; | + | |
- | #add extra value to "two" | + | # add new item (person => [(lastname = " |
- | $xavp(example[0]=>value)=" | + | $xavp(person=>lastname)="Doe"; |
- | #add value to first variable - "one" | + | |
- | $xavp(example[1]=>value)="Anna"; | + | # add another named value to the last example item |
+ | # | ||
+ | $xavp(person[0]=>firstname)=" | ||
+ | |||
+ | # add another named value to first example item | ||
+ | # | ||
+ | xavp(person[1]=>firstname)="Alice"; | ||
</ | </ | ||
Line 662: | Line 848: | ||
Another example: | Another example: | ||
<code c> | <code c> | ||
- | # Create | + | # create |
$xavp(sf=> | $xavp(sf=> | ||
- | #assign | + | # add named values |
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
- | #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=> | $xavp(sf=> | ||
+ | # add named values (child values) | ||
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
- | #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=> | $xavp(sf=> | ||
+ | # add named values (child values) | ||
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
$xavp(sf[0]=> | $xavp(sf[0]=> | ||
Line 682: | Line 870: | ||
</ | </ | ||
- | 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=> | ||
+ | </ | ||
+ | |||
+ | ===== $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=> | ||
+ | # $xavi(whatever[0]=> | ||
+ | </ | ||
===== $hdr(name) - Headers ===== | ===== $hdr(name) - Headers ===== | ||
- | **$hdr(name)** - represents the body of first header identified by ' | + | **$hdr(name)** - represents the body of first header |
+ | |||
+ | **$(hdr(name)[N])** - represents the body of the N-th header field identified by ' | ||
- | **$(hdr(name)[N])** - represents | + | 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 |
- | If [N] is omitted | + | If name is *, then any 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 705: | Line 919: | ||
<fc # | <fc # | ||
+ | ===== $hfl(name) - Header Field With List Of Bodies ===== | ||
+ | |||
+ | Similar to **$hdr(name)**, | ||
+ | |||
+ | 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 ' | ||
+ | |||
+ | **$(hfl(name)[N])** - represents the body of the N-th header field identified by ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | if($(hfl(Via)[1])=~" | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | ===== $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) { | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== $hflc(name) - Number of Header Bodies ===== | ||
+ | |||
+ | Similar to **$hdrc(name)**, | ||
+ | |||
+ | Implemented for: | ||
+ | |||
+ | * Via | ||
+ | |||
+ | For the rest of the headers works like **$hdrc(name)**. | ||
+ | |||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | if($hflc(Via)==3) { | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
===== $var(name) - Private memory variables (zero) ===== | ===== $var(name) - Private memory variables (zero) ===== | ||
Line 756: | Line 1024: | ||
===== $shv(name) - Shared memory variables ===== | ===== $shv(name) - Shared memory variables ===== | ||
- | **$shv(name)** | + | **$shv(name)** |
Example - shv(name) pseudo-variable usage: | Example - shv(name) pseudo-variable usage: | ||
Line 772: | Line 1040: | ||
<fc # | <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 ' | ||
+ | * reason - the SIP response reason that caused the execution of event_route ' | ||
+ | * flags - flags set internally when executing event_route ' | ||
===== $time(name) - Broken-down time ===== | ===== $time(name) - Broken-down time ===== | ||
Line 820: | Line 1097: | ||
<code c> | <code c> | ||
xlog(" | xlog(" | ||
+ | </ | ||
+ | |||
+ | ===== $ccp(key) - Config Custom Parameters ===== | ||
+ | |||
+ | Get the value for global custom parameters: | ||
+ | |||
+ | * https:// | ||
+ | |||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | gv.sval = " | ||
+ | gv.ival = 10 desc "ten var" | ||
+ | |||
+ | request_route { | ||
+ | xinfo(" | ||
+ | } | ||
</ | </ | ||
Line 838: | Line 1133: | ||
} | } | ||
</ | </ | ||
- | ===== Send Address | + | ===== Received Data Attributes ===== |
+ | |||
+ | ==== $rcv(key) ==== | ||
+ | |||
+ | Attributes of received data. The variables must be used inside **event_route[core: | ||
+ | |||
+ | 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: | ||
+ | xlog(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== $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(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Send Data Attributes ===== | ||
==== $sndfrom(name) ==== | ==== $sndfrom(name) ==== | ||
Line 857: | Line 1199: | ||
* 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 |
* 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 874: | Line 1216: | ||
</ | </ | ||
- | ===== Benchmark module Pseudo-Variables | + | ===== SIPDUMP Module ===== |
+ | |||
+ | ==== $sipdump(name) ==== | ||
+ | |||
+ | **$sipdump(name)** | ||
+ | |||
+ | 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: | ||
+ | if($sipdump(len) > 1024) { | ||
+ | ... | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== 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 | + | ===== Dialog |
==== $dlg(attr) ==== | ==== $dlg(attr) ==== | ||
Line 915: | Line 1287: | ||
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 #0000ff>Some of the attributes are R/W variables.</ |
The ' | The ' | ||
- | * set | + | * set - returns 1 if the dialog for current context is set, 0 otherwise |
- | * flags | + | * flags - get/set dialog |
- | * timeout_route | + | * timeout_route |
- | * timeout_bye | + | * timeout_route_id - get internal id for the route to be executed on timeout |
+ | * timeout_bye | ||
+ | * 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 931: | Line 1307: | ||
The ' | The ' | ||
- | ===== Erlang | + | ===== Erlang |
- | ==== 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 942: | Line 1318: | ||
==== $erl_atom(name) ==== | ==== $erl_atom(name) ==== | ||
+ | |||
// | // | ||
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 1001: | Line 1378: | ||
module. | module. | ||
- | ===== HTable | + | ===== HTable |
==== $sht(htable=> | ==== $sht(htable=> | ||
Line 1007: | Line 1384: | ||
Access hash table entries. | Access hash table entries. | ||
- | <fc # | + | <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 1119: | Line 1496: | ||
... | ... | ||
</ | </ | ||
- | ===== Memcached | + | |
+ | ==== $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(" | ||
+ | while(sht_iterator_next(" | ||
+ | xlog(" | ||
+ | } | ||
+ | sht_iterator_end(" | ||
+ | </ | ||
+ | |||
+ | ==== $shtrecord(id) ==== | ||
+ | |||
+ | Get the key or the value of expired item inside the event_route[htable: | ||
+ | |||
+ | The id can be: | ||
+ | |||
+ | * key | ||
+ | * value | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | event_route[htable: | ||
+ | xlog(" | ||
+ | } | ||
+ | </ | ||
+ | ===== Memcached | ||
==== $mct(key) ==== | ==== $mct(key) ==== | ||
Line 1195: | Line 1607: | ||
... | ... | ||
</ | </ | ||
+ | |||
+ | ===== 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/ | ||
+ | * body: sets/ | ||
+ | * method: sets the HTTP method: either " | ||
+ | * 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: | ||
+ | * tls_client_key: | ||
+ | * tls_ca_path: | ||
+ | * 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' | ||
+ | * tcp_keepalive: | ||
+ | * tcp_ka_idle: | ||
+ | * tcp_ka_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, | ||
+ | |||
+ | === $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 1213: | Line 1683: | ||
</ | </ | ||
- | ===== TMX module Pseudo-Variables | + | ===== TMX Module |
==== $T_branch_idx ==== | ==== $T_branch_idx ==== | ||
- | * the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. | + | * 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[], | ||
+ | * if used outside of transaction processing, the value is '-1' | ||
==== $T_reply_ruid ==== | ==== $T_reply_ruid ==== | ||
Line 1279: | Line 1753: | ||
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 |
- | * id_label - return the internal label of current transaction | + | * id_label - return the internal label of current transaction |
- | * reply_code - alias to $T_reply_code | + | * id_index_n - return the internal index of current transaction, |
- | * branch_index - alias to $T_branch_idx | + | * id_label_n - return the internal label of current transaction, |
+ | * 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 | * 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 1298: | Line 1776: | ||
- | ===== UAC module Pseudo-Variables | + | ===== UAC Module |
==== $uac_req(key) ==== | ==== $uac_req(key) ==== | ||
Line 1320: | Line 1798: | ||
* evcode - reply code for the request sent with uac_req_send(), | * evcode - reply code for the request sent with uac_req_send(), | ||
* 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: | * 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: | ||
+ | * 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 1333: | Line 1812: | ||
} | } | ||
</ | </ | ||
- | ===== Nathelper | + | ===== Nathelper |
==== $rr_count ==== | ==== $rr_count ==== | ||
Line 1343: | Line 1822: | ||
* 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 | + | ===== MQueue |
==== $mqk(q) ==== | ==== $mqk(q) ==== | ||
Line 1369: | Line 1848: | ||
==== $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 1389: | Line 1867: | ||
* $nh(P) - transport protocol (upper case p) | * $nh(P) - transport protocol (upper case p) | ||
- | ===== GeoIP module Pseudo-Variables | + | ===== NDB_REDIS Module ===== |
+ | |||
+ | ==== $redis(res=> | ||
+ | |||
+ | 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), | ||
+ | |||
+ | Example: | ||
+ | |||
+ | < | ||
+ | redis_cmd(" | ||
+ | xlog(" | ||
+ | </ | ||
+ | |||
+ | ==== $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=> | ||
+ | |||
+ | Example: | ||
+ | |||
+ | < | ||
+ | redis_cmd(" | ||
+ | if ($redis(r=> | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== GeoIP Module | ||
==== $gip(pvc=> | ==== $gip(pvc=> | ||
Line 1425: | Line 1955: | ||
</ | </ | ||
- | ===== TLS module Pseudo-Variables | + | ===== TLS Module |
==== $tls_version ==== | ==== $tls_version ==== | ||
Line 1494: | Line 2024: | ||
==== $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 1537: | Line 2071: | ||
==== $tls_peer_server_name ==== | ==== $tls_peer_server_name ==== | ||
The SNI server name of the peer | The SNI server name of the peer | ||
- | ===== XHTTP module Pseudo-Variables | + | |
+ | ==== $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, | ||
+ | |||
+ | ==== $tls_my_urlencoded_cert ==== | ||
+ | The PEM-encoded client certificate, | ||
+ | ===== 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 | ||
==== $hu ==== | ==== $hu ==== | ||
Line 1543: | Line 2102: | ||
* URL of http request. | * URL of http request. | ||
- | ===== MSRP Module | + | ===== 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 1612: | Line 2171: | ||
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 1743: | Line 2302: | ||
The key can be: | The key can be: | ||
- | * line - return 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 1814: | Line 2375: | ||
</ | </ | ||
- | ===== JSONRPC-S | + | ===== JSONRPCS |
==== $jsonrpl(key) - JSONRPC Reply ==== | ==== $jsonrpl(key) - JSONRPC Reply ==== | ||
Line 1825: | Line 2386: | ||
* body - the body of the JSONRPC response | * body - the body of the JSONRPC response | ||
- | ===== Presence Module | + | ===== Presence Module ===== |
==== $subs(key) - Subscription Attributes ==== | ==== $subs(key) - Subscription Attributes ==== | ||
Line 1833: | Line 2394: | ||
The key can be: | 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. | * 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=> | ||
+ | |||
+ | Access the attributes of contact addresses stored in ' | ||
+ | |||
+ | 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 | ||
+ | |||
+ | ===== $phn(rid=> | ||
+ | |||
+ | $phn(rid=> | ||
+ | |||
+ | * 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(" | ||
+ | if($phn(src=> | ||
+ | xlog(" | ||
+ | } else { | ||
+ | xlog(" | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== 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/ | ||
+ | * $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(// | ||
+ | * $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. | $C(xy) - reference to an escape sequence. “x” represents the foreground color and “y” represents the background color. |