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 [2015/10/12 20:36] oej |
cookbooks:devel:pseudovariables [2022/03/22 17:16] jih [$tn - To display name] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Kamailio SIP Server | + | ====== |
+ | |||
+ | Version: | ||
+ | |||
+ | {{ :cookbooks: | ||
===== Introduction ===== | ===== Introduction ===== | ||
Line 19: | Line 23: | ||
* avpops | * avpops | ||
* htable | * htable | ||
+ | * http_async_client | ||
* textops | * textops | ||
* uac | * uac | ||
Line 75: | 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 164: | Line 171: | ||
<code c> | <code c> | ||
xlog(" | xlog(" | ||
+ | </ | ||
+ | |||
+ | **$cnt(xavp)** - return the number of xavps | ||
+ | |||
+ | < | ||
+ | * $cnt($xavp(key[*])) : number of XAVPs " | ||
+ | * $cnt($xavp(key[n]=> | ||
+ | * $cnt($xavp(key[*]=> | ||
+ | |||
+ | * $cnt($xavp(key[n])) : 1 or 0 (if this index exists or not). | ||
+ | * $cnt($xavp(key[-n])) : same but with reverse indexing (-1 is the last index). | ||
+ | |||
+ | * $cnt($xavp(key[*]=> | ||
+ | |||
+ | * $cnt($xavp(key)) is the same as $cnt($xavp(key[*])). | ||
+ | * $cnt($xavp(key=> | ||
</ | </ | ||
==== $conid - TCP Connection ID ==== | ==== $conid - TCP Connection ID ==== | ||
Line 169: | Line 192: | ||
**$conid** - The TCP connection ID of the connection the current message arrived on for TCP, TLS, WS, and WSS. Set to $null for SCTP and UDP. | **$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 186: | Line 212: | ||
**$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 221: | Line 269: | ||
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 230: | Line 279: | ||
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 240: | Line 291: | ||
**$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 264: | Line 336: | ||
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 271: | Line 344: | ||
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 319: | Line 401: | ||
**$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 332: | Line 418: | ||
**$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 356: | Line 454: | ||
**$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 432: | Line 551: | ||
<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 439: | Line 565: | ||
**$rz** - returns R-URI scheme, possible values: sip, sips, tel, tels and urn, R-URI scheme parsing error should be reflected by value: none | **$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 | ||
+ | ==== $Rn - Received socket name ==== | ||
+ | |||
+ | **$Rn** - reference to the name of the socket 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 475: | Line 631: | ||
==== $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 501: | Line 664: | ||
==== $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 511: | Line 674: | ||
**$td** - reference to domain in URI of ' | **$td** - reference to domain in URI of ' | ||
+ | |||
+ | <fc # | ||
==== $tn - To display name ==== | ==== $tn - To display name ==== | ||
**$tn** - reference to display name of ' | **$tn** - reference to display name of ' | ||
+ | |||
+ | <fc # | ||
==== $tt - To tag ==== | ==== $tt - To tag ==== | ||
Line 530: | Line 697: | ||
**$tu** - reference to URI of ' | **$tu** - reference to URI of ' | ||
+ | |||
+ | <fc # | ||
==== $tU - To URI Username ==== | ==== $tU - To URI Username ==== | ||
**$tU** - reference to username in URI of ' | **$tU** - reference to username in URI of ' | ||
+ | |||
+ | <fc # | ||
+ | |||
+ | ==== $tUl - To URI Username Length ==== | ||
+ | |||
+ | **$tU** - the length of the username in To URI | ||
==== $Tb - Startup timestamp ==== | ==== $Tb - Startup timestamp ==== | ||
Line 567: | Line 742: | ||
**$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 637: | Line 829: | ||
===== $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 661: | Line 876: | ||
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 681: | Line 898: | ||
</ | </ | ||
- | 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 704: | Line 947: | ||
<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: | ||
+ | |||
+ | * Record-Route | ||
+ | * Route | ||
+ | * 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 755: | Line 1054: | ||
===== $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 771: | Line 1070: | ||
<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 819: | Line 1127: | ||
<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 837: | Line 1163: | ||
} | } | ||
</ | </ | ||
- | ===== 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(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== $msgbuf(index) ===== | ||
+ | |||
+ | Get or set the character in the message buffer at the position index. | ||
+ | |||
+ | The index has to be a positive integer or a variable holding such value. | ||
+ | |||
+ | Note that the variable returns a clone of the character stored in a static buffer, copy it to another variable if you want to compare with another $msgbuf(index). | ||
+ | |||
+ | The update is done directly and immediately in the message buffer -- use it with care! | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | if ($msgbuf(20)==" | ||
+ | $msgbuf(20) = " | ||
+ | } | ||
+ | </ | ||
+ | ===== Header Field Iterator ===== | ||
+ | |||
+ | ==== $hfitname(iname) ==== | ||
+ | |||
+ | The header name of the header field iterator. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | hf_iterator_start(" | ||
+ | while(hf_iterator_next(" | ||
+ | xlog(" | ||
+ | } | ||
+ | hf_iterator_end(" | ||
+ | </ | ||
+ | |||
+ | ==== $hfitbody(iname) ==== | ||
+ | |||
+ | The header body of the header field iterator. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | hf_iterator_start(" | ||
+ | while(hf_iterator_next(" | ||
+ | xlog(" | ||
+ | } | ||
+ | hf_iterator_end(" | ||
+ | </ | ||
+ | |||
+ | ===== Body Line Iterator ===== | ||
+ | |||
+ | ==== $blitval(iname) ==== | ||
+ | |||
+ | The value of the body line iterator. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | bl_iterator_start(" | ||
+ | while(bl_iterator_next(" | ||
+ | xlog(" | ||
+ | } | ||
+ | bl_iterator_end(" | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== Send Data Attributes ===== | ||
==== $sndfrom(name) ==== | ==== $sndfrom(name) ==== | ||
Line 856: | Line 1293: | ||
* 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) | ||
* 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 872: | Line 1310: | ||
</ | </ | ||
- | ===== 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) { | ||
+ | ... | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== SIPTRACE Module ===== | ||
+ | ==== $siptrace(name) ==== | ||
+ | |||
+ | **$siptrace(name)** - return attributes of the message handled in the event_route[siptrace: | ||
+ | |||
+ | The name can be: | ||
+ | |||
+ | * src_addr - source socket address (proto: | ||
+ | * dst_addr - destination socket address (proto: | ||
+ | * src_host - source host, for IPv6 host contains `[]` | ||
+ | * dst_host - destination host, for IPv6 host contains `[]` | ||
+ | * src_hostip - source host, for IPv6 host do not contains `[]` | ||
+ | * dst_hostip - destination host, for IPv6 host do not contains `[]` | ||
+ | * src_port - source port | ||
+ | * dst_port - destination port | ||
+ | * src_proto - source proto | ||
+ | * dst_proto - destination proto | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | event_route[siptrace: | ||
+ | { | ||
+ | if (allow_address(" | ||
+ | return; | ||
+ | |||
+ | } | ||
+ | if (compare_ips($siptrace(src_host), | ||
+ | return; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== 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 913: | Line 1415: | ||
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 929: | Line 1435: | ||
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 940: | Line 1446: | ||
==== $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 999: | Line 1506: | ||
module. | module. | ||
- | ===== HTable | + | ===== HTable |
==== $sht(htable=> | ==== $sht(htable=> | ||
Line 1005: | Line 1512: | ||
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 1117: | Line 1624: | ||
... | ... | ||
</ | </ | ||
- | ===== 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 1193: | Line 1735: | ||
... | ... | ||
</ | </ | ||
+ | |||
+ | ===== 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 1211: | Line 1811: | ||
</ | </ | ||
- | ===== 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 1277: | Line 1881: | ||
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 | ||
* 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 1295: | Line 1904: | ||
- | ===== UAC module Pseudo-Variables | + | ===== UAC Module |
==== $uac_req(key) ==== | ==== $uac_req(key) ==== | ||
Line 1309: | Line 1918: | ||
* hdrs - SIP Headers | * hdrs - SIP Headers | ||
* body - Body | * body - Body | ||
+ | * flags - flags for processing | ||
+ | * 1 - the password is provided in HA1 format | ||
* auser - authentication username | * auser - authentication username | ||
* apasswd - authentication password | * apasswd - authentication password | ||
Line 1317: | Line 1928: | ||
* 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 1330: | Line 1942: | ||
} | } | ||
</ | </ | ||
- | ===== Nathelper | + | ===== Nathelper |
==== $rr_count ==== | ==== $rr_count ==== | ||
Line 1340: | Line 1952: | ||
* 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 1366: | Line 1978: | ||
==== $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 ===== | ||
==== $nh(key) ==== | ==== $nh(key) ==== | ||
- | Return attributes of next hop for the SIP request. Address | + | Return attributes of next hop for the SIP messages. For SIP requests, the address |
* $nh(u) - uri (lower case u) | * $nh(u) - uri (lower case u) | ||
Line 1386: | Line 1997: | ||
* $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 1422: | Line 2085: | ||
</ | </ | ||
- | ===== TLS module Pseudo-Variables | + | ===== TLS Module |
+ | |||
+ | ==== $tls(key) ==== | ||
+ | |||
+ | Variables related to TLS communication and certificates. | ||
+ | |||
+ | The **key** can be: | ||
+ | |||
+ | * **m_issuer_line** - return local (my) certificate issuer line | ||
+ | * **p_issuer_line** - return remote (peer) certificate issuer line | ||
+ | * **m_subject_line** - return local (my) certificate subject line | ||
+ | * **p_subject_line** - return remote (peer) certificate subject line | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | if(proto==TLS) { | ||
+ | xinfo(" | ||
+ | } | ||
+ | </ | ||
==== $tls_version ==== | ==== $tls_version ==== | ||
+ | |||
The TLS/SSL version which is used on the TLS connection from which the message was received. String type. | The TLS/SSL version which is used on the TLS connection from which the message was received. String type. | ||
==== $tls_description ==== | ==== $tls_description ==== | ||
Line 1491: | Line 2174: | ||
==== $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 1514: | Line 2201: | ||
ip address in the " | ip address in the " | ||
- | ===== XHTTP module | + | ==== $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 | ||
+ | |||
+ | ==== $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 (surrounding white space and EoL chars trimmed) | ||
+ | * $msg(fline) - sip message first line (surrounding white space and EoL chars trimmed) | ||
+ | * $msg(fpart) - sip message first line and the headers | ||
+ | * $msg(lpart) - sip message headers and the body | ||
+ | ===== POSOPS Module ===== | ||
+ | |||
+ | ==== $pos(key) ==== | ||
+ | |||
+ | Get attributes after a function of the module | ||
+ | |||
+ | The key can be: | ||
+ | |||
+ | * ret - the return code on success or -1 | ||
+ | * idx - position inside message buffer, for find/search it is the start of matching | ||
+ | * len - the length of matching string for search functions | ||
+ | |||
+ | ===== XHTTP Module | ||
==== $hu ==== | ==== $hu ==== | ||
Line 1520: | Line 2265: | ||
* 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 1589: | Line 2334: | ||
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 ==== | ||
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(" | ||
+ | $fn = " | ||
+ | } | ||
+ | </ | ||
+ | |||
==== $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: | ||
+ | if($avp(s: | ||
+ | { | ||
+ | remove_hf(" | ||
+ | } | ||
+ | </ | ||
+ | |||
==== $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: | ||
+ | { | ||
+ | remove_hf(" | ||
+ | append_hf(" | ||
+ | } | ||
+ | </ | ||
==== $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc ==== | ==== $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc ==== | ||
Line 1605: | Line 2396: | ||
==== $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 = " | ||
+ | } | ||
+ | </ | ||
==== $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 = " | ||
+ | } | ||
+ | </ | ||
==== $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 | ||
+ | |||
+ | |||
+ | ==== $sipt(redirection_info) / $sipt_redirection_info === | ||
+ | Returns the value of the Redirecting reason of the Call Diversion Information header from ISUP. | ||
+ | Returns -1 if there is a parsing error or if the Call Diversion Information is not present. | ||
+ | |||
+ | Can return the following values: | ||
+ | |||
+ | * 0 Unknown | ||
+ | * 1 User busy | ||
+ | * 2 no reply | ||
+ | * 3 unconditional | ||
+ | * 4 deflection during alerting | ||
+ | * 5 deflection immediate response | ||
+ | * 6 mobile subscriber not reachable | ||
+ | |||
+ | |||
+ | ==== $sipt(redirection_number) / $sipt_redirection_number === | ||
+ | Returns the value (Address signal) of the Redirection Number. | ||
+ | Returns -1 if there is a parsing error or if the Redirection Number is not present. | ||
+ | |||
+ | Example: | ||
+ | <code c> | ||
+ | # get the redirection number | ||
+ | $avp(s: | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== $sipt(redirection_number.nai) / $sipt_redirection_number_nai === | ||
+ | Returns the value of the Nature of Address Indicator of the Redirection Number. Returns -1 if there is a parsing error or if the Redirection Number is not present. | ||
+ | |||
+ | Can return the following values: | ||
+ | |||
+ | * 0 Spare | ||
+ | * 1 Subscriber Number (national use) | ||
+ | * 2 Unknown (national use) | ||
+ | * 3 National (significant) number | ||
+ | * 4 International use | ||
+ | |||
+ | |||
+ | ==== $sipt(calling_party_number) === | ||
+ | Returns the value (Address signal) of the Calling Party for the IAM message. | ||
+ | Returns -1 if there is a parsing error or if the Calling Party Number is not present. | ||
+ | |||
+ | |||
+ | ==== $sipt(called_party_number) === | ||
+ | Returns the value (Address signal) of the Called Party for the IAM message. | ||
+ | Returns -1 if there is a parsing error or if the Called Party Number is not present. | ||
+ | |||
+ | |||
+ | ==== $sipt(sipt_redirection_information_reason) === | ||
+ | Returns the value of the Redirection reason of the Redirection information header from ISUP. | ||
+ | Returns -1 if there is a parsing error or if the Redirection information is not present. | ||
+ | |||
+ | |||
+ | ==== $sipt(sipt_redirection_information_original_reason) === | ||
+ | Returns the value of the Original Redirection reason of the Redirection information header from ISUP. | ||
+ | Returns -1 if there is a parsing error or if the Redirection information is not present. | ||
+ | |||
+ | |||
+ | ==== $sipt(redirecting_number.nai) === | ||
+ | Returns the value of the Nature of Address Indicator of the Redirecting Number. Returns -1 if there is a parsing error or if the Redirecting Number is not present. | ||
+ | |||
+ | Can return the following values: | ||
+ | |||
+ | * 0 Spare | ||
+ | * 1 Subscriber Number (national use) | ||
+ | * 2 Unknown (national use) | ||
+ | * 3 National (significant) number | ||
+ | * 4 International use | ||
+ | |||
+ | |||
+ | ==== $sipt(redirecting_number) === | ||
+ | Returns the value (Address signal) of the Redirecting Number for the IAM message. | ||
+ | Returns -1 if there is a parsing error or if the Redirecting Number is not present. | ||
+ | |||
+ | |||
+ | ==== $sipt(original_called_number.nai) === | ||
+ | Returns the value of the Nature of Address Indicator of the Original Called Number. Returns -1 if there is a parsing error or if the Original Called Number is not present. | ||
+ | |||
+ | Can return the following values: | ||
+ | |||
+ | * 0 Spare | ||
+ | * 1 Subscriber Number (national use) | ||
+ | * 2 Unknown (national use) | ||
+ | * 3 National (significant) number | ||
+ | * 4 International use | ||
+ | |||
+ | |||
+ | ==== $sipt(original_called_number) === | ||
+ | Returns the value (Address signal) of the Original Called Number for the IAM message. | ||
+ | Returns -1 if there is a parsing error or if the Original Called Number is not present. | ||
+ | |||
+ | |||
+ | ==== $sipt(generic_number.nai) === | ||
+ | Returns the value of the Nature of Address Indicator of the Generic Number. Returns -1 if there is a parsing error or if the Generic Number is not present. | ||
+ | |||
+ | Can return the following values: | ||
+ | |||
+ | * 0 Spare | ||
+ | * 1 Subscriber Number (national use) | ||
+ | * 2 Unknown (national use) | ||
+ | * 3 National (significant) number | ||
+ | * 4 International use | ||
+ | |||
+ | |||
+ | ==== $sipt(generic_number) === | ||
+ | Returns the value (Address signal) of the Generic Number for the IAM message. | ||
+ | Returns -1 if there is a parsing error or if the Generic Number is not present. | ||
+ | |||
===== $cfg(key) - Config File Attributes ===== | ===== $cfg(key) - Config File Attributes ===== | ||
Line 1618: | Line 2574: | ||
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 1689: | Line 2647: | ||
</ | </ | ||
- | ===== JSONRPC-S | + | ===== JSONRPCS |
==== $jsonrpl(key) - JSONRPC Reply ==== | ==== $jsonrpl(key) - JSONRPC Reply ==== | ||
Line 1700: | Line 2658: | ||
* 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 1708: | Line 2666: | ||
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 | ||
+ | |||
+ | ===== Phonenum Variables ===== | ||
+ | |||
+ | $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(" | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== SecSIPId Variables ===== | ||
+ | |||
+ | $secsipid(key) - return attributes of secsipid module. | ||
+ | |||
+ | The key can be: | ||
+ | |||
+ | * val - the value of Identity computed by secsipid_build_identity(...) | ||
+ | * ret - the return code of the libsecsipid function used by secsipid_build_identity(...) | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | if(secsipid_build_identity(" | ||
+ | " | ||
+ | xinfo(" | ||
+ | } | ||
+ | </ | ||
+ | ===== 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) | ||
+ | |||
+ | ===== $via0(attr) - Via[0] Attributes ===== | ||
+ | |||
+ | $via0(attr) - attributes of first Via header. | ||
+ | |||
+ | The attr can be: | ||
+ | |||
+ | * host - host part (string) | ||
+ | * port - port (number) | ||
+ | * proto - protocol - transport part (string) | ||
+ | * protoid - protocol id (integer id) | ||
+ | * branch - branch parameter | ||
+ | * rport - rport parameter value (string) | ||
+ | * received - received parameter value (string) | ||
+ | * i - i parameter value (string) | ||
+ | |||
+ | ===== $via1(attr) - Second Via Attributes ===== | ||
+ | |||
+ | $via1(attr) - attributes of second Via header. The attr can be the same as for $via0(attr). | ||
+ | |||
+ | ===== $viaZ(attr) - Last Via Attributes ===== | ||
+ | |||
+ | $viaZ(attr) - attributes of last Via header. The attr can be the same as for $via0(attr). | ||
+ | ===== tcpops module variable ===== | ||
+ | |||
+ | $tcp(key) - return TCP connection attributes. | ||
+ | |||
+ | The key can be: | ||
+ | * c_si - connection source ip (useful with HAProxy connections) | ||
+ | * c_sp - connection source port (useful with HAProxy connections) | ||
+ | * conid - connection id | ||
+ | |||
+ | |||
+ | ===== pv_headers module variables ===== | ||
+ | |||
+ | * $x_hdr(// | ||
+ | * $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. | ||
Line 1726: | Line 2808: | ||
+ | ===== $K(key) - Kamailio Constants ===== | ||
+ | $K(key) - return the numeric values corresponding to Kamailio configuration constants. | ||
+ | The key can be: | ||
+ | |||
+ | * IPv4 - return AF_INET | ||
+ | * IPv6 - return AF_INET6 | ||
+ | * UDP - return PROTO_UDP | ||
+ | * TCP - return PROTO_TCP | ||
+ | * TLS - return PROTO_TLS | ||
+ | * SCTP - return PROTO_SCTP | ||
+ | * WS - return PROTO_WS | ||
+ | * WSS - return PROTO_WSS | ||
+ | |||
+ | |||
+ | <code c> | ||
+ | xinfo(" | ||
+ | </ | ||
===== Examples ===== | ===== Examples ===== | ||