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 [2020/03/17 08:43] miconda [$env(NAME) - environment variables] |
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 v5.4.x (devel): Pseudo-Variables ====== | ||
===== Introduction ===== | ===== Introduction ===== | ||
Line 193: | 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 243: | Line 268: | ||
**$fd** - reference to domain in URI of ' | **$fd** - reference to domain in URI of ' | ||
+ | |||
+ | <fc # | ||
==== $fn - From display name ==== | ==== $fn - From display name ==== | ||
Line 248: | 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 272: | 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 279: | 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 ==== | ||
Line 331: | 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 380: | 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 455: | Line 534: | ||
<fc # | <fc # | ||
+ | |||
+ | ==== $rUl - R-URI Username Length ==== | ||
+ | |||
+ | **$rU** - the length of the username in R-URI | ||
==== $rv - SIP message version ==== | ==== $rv - SIP message version ==== | ||
Line 594: | 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 714: | 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 738: | 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 758: | 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 identified by ' | + | **$(hdr(name)[N])** - represents the body of the N-th header |
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=' | 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=' | ||
Line 783: | 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) - Number of Headers ===== | ||
Line 795: | Line 955: | ||
</ | </ | ||
+ | ===== $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 919: | 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 960: | Line 1156: | ||
event_route[core: | event_route[core: | ||
xlog(" | 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(" | ||
} | } | ||
</ | </ | ||
Line 1470: | Line 1687: | ||
==== $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 1850: | Line 2071: | ||
==== $tls_peer_server_name ==== | ==== $tls_peer_server_name ==== | ||
The SNI server name of the peer | The SNI server name of the peer | ||
+ | |||
+ | ==== $tls_peer_raw_cert ==== | ||
+ | The raw PEM-encoded client certificate. String type. | ||
+ | |||
+ | ==== $tls_my_raw_cert ==== | ||
+ | The raw PEM-encoded client certificate. String type. | ||
+ | |||
+ | ==== $tls_peer_urlencoded_cert ==== | ||
+ | The PEM-encoded client certificate, | ||
+ | |||
+ | ==== $tls_my_urlencoded_cert ==== | ||
+ | The PEM-encoded client certificate, | ||
===== SIP Message Attributes ===== | ===== SIP Message Attributes ===== | ||