From openSIPS

Documentation: Core Variables - 3.1

Documentation -> Manuals -> Manual 3.1 -> Core Variables

Pages for other versions: devel 3.2 3.1 Older versions: 3.0 2.4 2.3 2.2 2.1 1.11 1.10 1.9 1.8 1.7 1.6 1.5 1.4


Core Variables v3.1
PrevNext

Table of Contents (hide)

  1. 1. Script variables
  2. 2. AVP variables
  3. 3. Scripting Variables
    1. 3.1 URI in SIP Request's P-Asserted-Identity header - $ai
    2. 3.2 Authentication Digest URI - $adu
    3. 3.3 Authentication realm - $ar
    4. 3.4 Auth username user - $au
    5. 3.5 Auth username domain - $ad
    6. 3.6 Auth nonce - $an
    7. 3.7 Auth response - $auth.resp
    8. 3.8 Auth nonce - $auth.nonce
    9. 3.9 Auth opaque - $auth.opaque
    10. 3.10 Auth algorithm - $auth.alg
    11. 3.11 Auth QOP - $auth.qop
    12. 3.12 Auth nonce count (nc) - $auth.nc
    13. 3.13 Auth whole username - $aU
    14. 3.14 Acc username - $Au
    15. 3.15 Argument options - $argv
    16. 3.16 Address family (Obsoleted with OpenSIPS 3.1) - $af
    17. 3.17 Branch flags list - $bf
    18. 3.18 Branch - $branch
    19. 3.19 Branch fields - $branch.fields
    20. 3.20 Branch flag - $branch.flag
    21. 3.21 Call-Id - $ci
    22. 3.22 Content-Length - $cl
    23. 3.23 CSeq number - $cs
    24. 3.24 Contact instance - $ct
    25. 3.25 Fields of a contact instance - $ct.fields
    26. 3.26 Content-Type - $cT
    27. 3.27 Domain of destination URI - $dd
    28. 3.28 Diversion header URI - $di
    29. 3.29 Diversion "privacy" parameter - $dip
    30. 3.30 Diversion "reason" parameter - $dir
    31. 3.31 Port of destination URI - $dp
    32. 3.32 Transport protocol of destination URI - $dP
    33. 3.33 Destination set - $ds
    34. 3.34 Destination URI - $du
    35. 3.35 Error class - $err.class
    36. 3.36 Error level - $err.level
    37. 3.37 Error info - $err.info
    38. 3.38 Error reply code - $err.rcode
    39. 3.39 Error reply reason - $err.rreason
    40. 3.40 From URI domain - $fd
    41. 3.41 From display name - $fn
    42. 3.42 Forced socket (Obsoleted with OpenSIPS 3.1) - $fs
    43. 3.43 From tag - $ft
    44. 3.44 From URI - $fu
    45. 3.45 From URI username - $fU
    46. 3.46 OpenSIPS Log level - $log_level
    47. 3.47 SIP message buffer
    48. 3.48 Message Flags - $mf
    49. 3.49 SIP message ID - $mi
    50. 3.50 SIP message length - $ml
    51. 3.51 Message flag - $msg.flag
    52. 3.52 Message is request - $msg.is_request
    53. 3.53 Message type - $msg.type
    54. 3.54 Domain in SIP Request's original URI - $od
    55. 3.55 Port of SIP request's original URI - $op
    56. 3.56 Transport protocol of SIP request original URI - $oP
    57. 3.57 SIP Request's original URI - $ou
    58. 3.58 Username in SIP Request's original URI - $oU
    59. 3.59 Route parameter - $param
    60. 3.60 Domain in SIP Request's P-Preferred-Identity header URI - $pd
    61. 3.61 Display Name in SIP Request's P-Preferred-Identity header - $pn
    62. 3.62 Process id - $pp
    63. 3.63 Protocol of received message (Obsoleted with OpenSIPS 3.1)
    64. 3.64 User in SIP Request's P-Preferred-Identity header URI - $pU
    65. 3.65 URI in SIP Request's P-Preferred-Identity header - $pu
    66. 3.66 Domain in SIP Request's URI - $rd
    67. 3.67 Body of request/reply - $rb
    68. 3.68 Returned code - $rc
    69. 3.69 Remote-Party-ID header URI - $re
    70. 3.70 SIP request's method - $rm
    71. 3.71 SIP request's port - $rp
    72. 3.72 Transport protocol of SIP request URI - $rP
    73. 3.73 SIP reply's reason - $rr
    74. 3.74 SIP reply's status - $rs
    75. 3.75 Refer-to URI - $rt
    76. 3.76 SIP Request's URI - $ru
    77. 3.77 Username in SIP Request's URI - $rU
    78. 3.78 Q value of the SIP Request's URI - $ru_q
    79. 3.79 Received IP address (Obsoleted with OpenSIPS 3.1) - $Ri
    80. 3.80 Received port (Obsoleted with OpenSIPS 3.1) - $Rp
    81. 3.81 IP source address - $si
    82. 3.82 Socket inbound - $socket_in
    83. 3.83 Socket outbound - $socket_out
    84. 3.84 Source port - $sp
    85. 3.85 To URI Domain - $td
    86. 3.86 To display name - $tn
    87. 3.87 To tag - $tt
    88. 3.88 To URI - $tu
    89. 3.89 To URI Username - $tU
    90. 3.90 Formatted date and time - $time
    91. 3.91 Branch index - $T_branch_idx
    92. 3.92 String formatted time - $Tf
    93. 3.93 Current unix time stamp in seconds - $Ts
    94. 3.94 Current microseconds of the current second - $Tsm
    95. 3.95 Startup unix time stamp - $TS
    96. 3.96 User agent header - $ua
    97. 3.97 SIP Headers - $hdr
    98. 3.98 Route Type - $rT
    99. 3.99 Current script line and file - $cfg_line
    100. 3.100 Log level for xlog()
  4. 4. Escape Sequences
    1. 4.1 Foreground and background colors
    2. 4.2 Examples

OpenSIPS provides multiple type of variables to be used in the routing script. The difference between the types of variables comes from (1) the visibility of the variable (when it is visible), (2) what the variable is attached to (where the variable resides), (3) read-write status of the variable (some types of the variables are read-only and (4) how multiple values (for the same variable are handled).

The OpenSIPS variables can be easily identified in the script as all their names (or notations) start with the $ sign.

Syntax:
The complete syntax for a pseudo variable is:

$(<context>name(subname)[index]{transformation})

The fields written in green are optional. The fields meaning is:

Usage examples:

Types of variables:

1. Script variables 🔗

Naming: **$var(name)**

Hints:

  1. if you want to start using a script variable in a route, better initialize it with same value (or reset it), otherwise you may inherit a value from a previous route that was executed by the same process.
  2. script variables are faster than AVPs, as they directly reference a memory location.
  3. the value of script variables persists over a OpenSIPS process.
  4. a script variable can only hold one value.

Example of usage:

$var(a) = 2;  # sets the value of variable 'a' to integer '2'
$var(a) = "2";  # sets the value of variable 'a' to string '2'
$var(a) = 3 + (7&(~2)); # arithmetic and bitwise operation
$var(a) = "sip:" + $au + "@" + $fd; # compose a value from authentication username and From URI domain

# using a script variable for tests
if( [ $var(a) & 4 ] ) {
  xlog("var a has third bit set\n");
}

Setting a variable to NULL is actually initializing the value to integer '0'. Script variables don't have NULL value.

2. AVP variables 🔗

Naming: **$avp(name)** or **$(avp(name)[N])**

When using the index "N" you can force the AVP to return a certain value (the N-th value). If no index is given, the first value will be returned.

Hints:

  1. to enable AVPs in onreply_route, use "modparam("tm", "onreply_avp_mode", 1)"
  2. if multiple values are used for a single AVP, the values are index in revert order than added
  3. AVPs are part of the transaction context, so they will be visible everywhere where the transaction is present.
  4. the value of an AVP can be deleted

Example of usage:

  1. Transaction persistence example
# enable avps in onreply route
modparam("tm", "onreply_avp_mode", 1)
...
route{
...
$avp(tmp) = $Ts ; # store the current time (at request processing)
...
t_onreply("1");
t_relay();
...
}

onreply_route[1] {
	if (t_check_status("200")) {
		# calculate the setup time
		$var(setup_time) = $Ts - $avp(tmp);
	}
}
  1. Multiple values example
$avp(17) = "one";
# we have a single value
$avp(17) = "two";
# we have two values ("two","one")
$avp(17) = "three";
# we have three values ("three","two","one")

xlog("accessing values with no index: $avp(17)\n");
# this will print the first value, which is the last added value -> "three"

xlog("accessing values with no index: $(avp(17)[2])\n");
# this will print the index 2 value (third one), -> "one"

# remove the last value of the avp; if there is only one value, the AVP itself will be destroyed
$avp(17) = NULL;

# delete all values and destroy the AVP
avp_delete("$avp(17)/g");

# delete the value located at a certain index 
$(avp(17)[1]) = NULL;

#overwrite the value at a certain index
$(avp(17)[0]) = "zero";

The AVPOPS module provides a lot of useful functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc).

3. Scripting Variables 🔗

Naming: $name

Hints:

  1. the PV tokens can be given as parameters to different script functions and they will be replaced with a value before the execution of the function.
  2. most of PVs are made available by OpenSIPS core, but there are also module exporting PV (to make available info specific to that module) - check the modules documentation.

Predefined (provided by core) PVs are listed in alphabetical order.

3.1  URI in SIP Request's P-Asserted-Identity header - $ai 🔗

$ai - reference to URI in request's P-Asserted-Identity header (see RFC 3325)

3.2  Authentication Digest URI - $adu 🔗

$adu - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response.

3.3  Authentication realm - $ar 🔗

$ar - realm from Authorization or Proxy-Authorization header

3.4  Auth username user - $au 🔗

$au - user part of username from Authorization or Proxy-Authorization header

3.5  Auth username domain - $ad 🔗

$ad - domain part of username from Authorization or Proxy-Authorization header

3.6  Auth nonce - $an 🔗

$an - the nonce from Authorization or Proxy-Authorization header

3.7  Auth response - $auth.resp 🔗

$auth.resp - the authentication response from Authorization or Proxy-Authorization header

3.8  Auth nonce - $auth.nonce 🔗

$auth.nonce - the nonce string from Authorization or Proxy-Authorization header

3.9  Auth opaque - $auth.opaque 🔗

$auth.opaque - the opaque string from Authorization or Proxy-Authorization header

3.10  Auth algorithm - $auth.alg 🔗

$auth.alg - the algorithm string from Authorization or Proxy-Authorization header

3.11  Auth QOP - $auth.qop 🔗

$auth.qop - the value of qop parameter from Authorization or Proxy-Authorization header

3.12  Auth nonce count (nc) - $auth.nc 🔗

$auth.nc - the value of nonce count parameter from Authorization or Proxy-Authorization header

3.13  Auth whole username - $aU 🔗

$aU - whole username from Authorization or Proxy-Authorization header

3.14  Acc username - $Au 🔗

$Au - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

3.15  Argument options - $argv 🔗

$argv - provides access to command line arguments specified with '-o' option. Examples:

   # for option '-o foo=0'
   xlog("foo is $argv(foo) \n");

3.16  Address family (Obsoleted with OpenSIPS 3.1) - $af 🔗

Use $socket_in(af) instead.

3.17  Branch flags list - $bf 🔗

$bf - displays a list with the branch flags set for the current SIP request

3.18  Branch - $branch 🔗

$branch - this variable is used for creating new branches by writing into it the value of a SIP URI. Examples:

   # creates a new branch
   $branch = "sip:new@doamin.org";
   # print its URI
   xlog("last added branch has URI $(branch(uri)[-1]) \n");

3.19  Branch fields - $branch.fields 🔗

$branch() - this variable provides read/write access to all fields/attributes of an already existing branch (prior created with append_branch() ). The fields of the branch are:

The variable accepts also index $(branch(uri)[1]) for accessing a specific branch (multiple branches can be defined at a moment). The index starts from 0 (first branch). If the index is negative, it is considered the n-th branch from the end ( index -1 means the last branch).
To get all branches, use the * index - $(branch(uri)[*]).
Examples:

   # creates the first branch
   append_branch();
   # creates the second branch
   force_send_socket(udp:193.168.1.12:5060);
   $du = "sip:193.168.3.10";
   append_branch("sip:foo@bar.com","0.5");

   # display branches
   xlog("----- branch 0: $(branch(uri)[0]) , $(branch(q)[0]), $(branch(duri)[0]), $(branch(path)[0]), $(branch(flags)[0]), $(branch(socket)[0]) \n");
   xlog("----- branch 1: $(branch(uri)[1]) , $(branch(q)[1]), $(branch(duri)[1]), $(branch(path)[1]), $(branch(flags)[1]), $(branch(socket)[1]) \n");

   # do some changes over the branches
   $branch(uri) = "sip:user@domain.ro";   # set URI for the first branch
   $(branch(q)[0]) = 1000;  # set to 1.00 for the first branch
   $(branch(socket)[1]) = NULL;  # reset the socket of the second branch
   $branch(duri) = NULL;  # reset the destination URI or the first branch

It is R/W variable (you can assign values to it from routing logic)

3.20  Branch flag - $branch.flag 🔗

$branch.flag(flag_name)[] - this variable provides read/write access to the value of a single certain branch flag (identified by name). The values accepted for writing are 1 (set) and 0 (unset). The returned values are 1/"true" (set) and 0/"false" (unset). An index is accepted, in order to access the flag for a certain branch. By default the 0 (or current) branch accessed (for more on index, see the the branch.fields variable) - note that "*" is not accepted.

  setbflag("X");
  xlog("---- flag value is $branch.flag(X) \n");
  $branch.flag(X) = off;
  xlog("---- flag value is $branch.flag(X) \n");

3.21  Call-Id - $ci 🔗

$ci - reference to body of call-id header

3.22  Content-Length - $cl 🔗

$cl - reference to body of content-length header

3.23  CSeq number - $cs 🔗

$cs - reference to cseq number from cseq header

3.24  Contact instance - $ct 🔗

$ct - reference to contact instance/body from the contact header. A contact instance is display_name + URI + contact_params. As a Contact header may contain multiple Contact instances and a message may contain multiple Contact headers, an index was added to the $ct variable:

3.25  Fields of a contact instance - $ct.fields 🔗

$ct.fields() - reference to the fields of a contact instance/body (see above). Supported fields are:

Examples:

3.26  Content-Type - $cT 🔗

$cT - reference to body of Content-Type header and also the content-type headers inside a multi-part body

3.27  Domain of destination URI - $dd 🔗

$dd - reference to domain of destination uri

It is R/W variable (you can assign values to it from routing logic)

3.28  Diversion header URI - $di 🔗

$di - reference to Diversion header URI

3.29  Diversion "privacy" parameter - $dip 🔗

$dip - reference to Diversion header "privacy" parameter value

3.30  Diversion "reason" parameter - $dir 🔗

$dir - reference to Diversion header "reason" parameter value

3.31  Port of destination URI - $dp 🔗

$dp - reference to port of destination uri

It is R/W variable (you can assign values to it from routing logic)

3.32  Transport protocol of destination URI - $dP 🔗

$dP - reference to transport protocol of destination uri

3.33  Destination set - $ds 🔗

$ds - reference to destination set

3.34  Destination URI - $du 🔗

$du - reference to destination uri (outbound proxy to be used for sending the request) If loose_route() returns TRUE a destination uri is set according to the first Route header.

It is R/W variable (you can assign values to it from routing logic)

3.35  Error class - $err.class 🔗

$err.class - the class of error (now is '1' for parsing errors)

3.36  Error level - $err.level 🔗

$err.level - severity level for the error

3.37  Error info - $err.info 🔗

$err.info - text describing the error

3.38  Error reply code - $err.rcode 🔗

$err.rcode - recommended reply code

3.39  Error reply reason - $err.rreason 🔗

$err.rreason - recommended reply reason phrase

3.40  From URI domain - $fd 🔗

$fd - reference to domain in URI of 'From' header

3.41  From display name - $fn 🔗

$fn - reference to display name of 'From' header

3.42  Forced socket (Obsoleted with OpenSIPS 3.1) - $fs 🔗

Use $socket_out instead.

3.43  From tag - $ft 🔗

$ft - reference to tag parameter of 'From' header

3.44  From URI - $fu 🔗

$fu - reference to URI of 'From' header

3.45  From URI username - $fU 🔗

$fU - reference to username in URI of 'From' header

3.46  OpenSIPS Log level - $log_level 🔗

$log_level - changes the log level for the current process ; the log level can be set to a new value (see possible values or it can be reset back to the global log level. This function is very helpful if you are tracing and debugging only a specific piece of code.

Example of usage:

    log_level= -1 # errors only
    .....
    {
      ......
      $log_level = 4; # set the debug level of the current process to DBG
      uac_replace_from(....);
      $log_level = NULL; # reset the log level of the current process to its default level
      .......
    }

3.47 SIP message buffer

$mb - reference to SIP message buffer

3.48  Message Flags - $mf 🔗

$mf - displays a list with the message/transaction flags set for the current SIP request

3.49  SIP message ID - $mi 🔗

$mi - reference to SIP message id

3.50  SIP message length - $ml 🔗

$ml - reference to SIP message length

3.51  Message flag - $msg.flag 🔗

$msg.flag(flag_name) - this variable provides read/write access to the value of a single certain message flag (identified by name). The values accepted for writing are 1 (set) and 0 (unset). The returned values are 1/"true" (set) and 0/"false" (unset).

  setflag("X");
  xlog("---- flag value is $msg.flag(X) \n");
  $msg.flag(X) = off;
  xlog("---- flag value is $msg.flag(X) \n");

3.52  Message is request - $msg.is_request 🔗

$msg.is_request - this variable tells if the current SIP message is a request or not. The returned values are 1/"true" (request) and 0/"false" (reply).

  xlog("---- this message is a request:  $msg.is_request \n");
  if ( $msg.is_request )
    xlog("---- yes, it is a request\n");

3.53  Message type - $msg.type 🔗

$msg.type - this variable returns the type of the current message. The returned values are "request" (request) or "reply" (reply).

  xlog("---- this message is a SIP $msg.type \n");

3.54  Domain in SIP Request's original URI - $od 🔗

$od - reference to domain in request's original R-URI

3.55  Port of SIP request's original URI - $op 🔗

$op - reference to port of original R-URI

3.56  Transport protocol of SIP request original URI - $oP 🔗

$oP - reference to transport protocol of original R-URI

3.57  SIP Request's original URI - $ou 🔗

$ou - reference to request's original URI

3.58  Username in SIP Request's original URI - $oU 🔗

$oU - reference to username in request's original URI

3.59  Route parameter - $param 🔗

$param(idx) - retrieves the parameters of the route. The index can be an integer, or a pseudo-variable (index starts at 1).
Example:

   route {
      ...
      $var(debug) = "DBUG:"
      route(PRINT_VAR, $var(debug), "param value");
      ...
   }

   route[PRINT_VAR] {
      $var(index) = 2;
      xlog("$param(1): The parameter value is <$param($var(index))>\n");
   }

3.60  Domain in SIP Request's P-Preferred-Identity header URI - $pd 🔗

$pd - reference to domain in request's P-Preferred-Identity header URI (see RFC 3325)

3.61  Display Name in SIP Request's P-Preferred-Identity header - $pn 🔗

$pn - reference to Display Name in request's P-Preferred-Identity header (see RFC 3325)

3.62  Process id - $pp 🔗

$pp - reference to process id (pid)

3.63 Protocol of received message (Obsoleted with OpenSIPS 3.1)

Use $socket_in(proto) instead.

3.64  User in SIP Request's P-Preferred-Identity header URI - $pU 🔗

$pU - reference to user in request's P-Preferred-Identity header URI (see RFC 3325)

3.65  URI in SIP Request's P-Preferred-Identity header - $pu 🔗

$pu - reference to URI in request's P-Preferred-Identity header (see RFC 3325)

3.66  Domain in SIP Request's URI - $rd 🔗

$rd - reference to domain in request's URI

It is R/W variable (you can assign values to it routing script)

3.67  Body of request/reply - $rb 🔗

$rb - reference to the body or a body part of the SIP message

3.68  Returned code - $rc 🔗

$rc - reference to returned code by last invoked function

$retcode - same as **$rc**

3.69  Remote-Party-ID header URI - $re 🔗

$re - reference to Remote-Party-ID header URI

3.70  SIP request's method - $rm 🔗

$rm - reference to request's method

3.71  SIP request's port - $rp 🔗

$rp - reference to port of R-URI

It is R/W variable (you can assign values to it routing script)

3.72  Transport protocol of SIP request URI - $rP 🔗

$rP - reference to transport protocol of R-URI

3.73  SIP reply's reason - $rr 🔗

$rr - reference to reply's reason

3.74  SIP reply's status - $rs 🔗

$rs - reference to reply's status

3.75  Refer-to URI - $rt 🔗

$rt - reference to URI of refer-to header

3.76  SIP Request's URI - $ru 🔗

$ru - reference to request's URI

It is R/W variable (you can assign values to it routing script)

3.77  Username in SIP Request's URI - $rU 🔗

$rU - reference to username in request's URI

It is R/W variable (you can assign values to it routing script)

3.78  Q value of the SIP Request's URI - $ru_q 🔗

$ru_q - reference to q value of the R-URI

It is R/W variable (you can assign values to it routing script)

3.79  Received IP address (Obsoleted with OpenSIPS 3.1) - $Ri 🔗

Use $socket_in(ip) instead.

3.80  Received port (Obsoleted with OpenSIPS 3.1) - $Rp 🔗

Use $socket_in(port) instead.

3.81  IP source address - $si 🔗

$si - reference to IP source address of the message

3.82  Socket inbound - $socket_in 🔗

$socket_in - read-only variable to get the description (proto:ip:port format) of the inbound socket (used for receiving the message).
The variable also offers detailed read-only access to various attributes/sub-fields of the socket, as $socket_in(). The sub-fields of the socket are:

For more details on the meaning of these sub-fields, please also read about the socket definition.

3.83  Socket outbound - $socket_out 🔗

$socket_out - read-write variable for reading or changing the outbound socket of the message. Originally (before being written/changed) it will return the same socket description as $socket_in (the inbound socket will be used as outbound socket also).
The variable also offers detailed read-only access to various attributes/sub-fields of the socket, as $socket_out()'''. It provides the same sub-fields as the $socket_in variable.

   $socket_out = "udp:11.11.11:5060";
   xlog("The outbound port is $socket_out(port)\n");

3.84  Source port - $sp 🔗

$sp - reference to the source port of the message

3.85  To URI Domain - $td 🔗

$td - reference to domain in URI of 'To' header

3.86  To display name - $tn 🔗

$tn - reference to display name of 'To' header

3.87  To tag - $tt 🔗

$tt - reference to tag parameter of 'To' header

3.88  To URI - $tu 🔗

$tu - reference to URI of 'To' header

3.89  To URI Username - $tU 🔗

$tU - reference to username in URI of 'To' header

3.90  Formatted date and time - $time 🔗

$time(format) - returns the string formatted time according to UNIX date (see: man date).

3.91  Branch index - $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[]. If used outside of branch_route[] block, the value is '0'. This is exported by TM module.

3.92  String formatted time - $Tf 🔗

$Tf - reference string formatted time

3.93  Current unix time stamp in seconds - $Ts 🔗

$Ts - reference to current unix time stamp in seconds

3.94  Current microseconds of the current second - $Tsm 🔗

$Tsm - reference to current microseconds of the current second

3.95  Startup unix time stamp - $TS 🔗

$TS - reference to startup unix time stamp

3.96  User agent header - $ua 🔗

$ua - reference to user agent header field

3.97  SIP Headers - $hdr 🔗

$(hdr(name)[N]) - represents the body of the N-th header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.

The module should identify most of compact header names (the ones recognized by OpenSIPS which should be all at this moment), if not, the compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster.

$(hdr_name[N]) - returns the name of the N-th header. The first header name is obtained for N=0, the second for N=1, a.s.o. To print the last header name use -1, the second last -2 a.s.o. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all header names are printed.

$(hdrcnt(name)) -- returns number of headers of type given by 'name'. Uses same rules for specifying header names as $hdr(name) above. Many headers (e.g., Via, Path, Record-Route) may appear more than once in the message. This variable returns the number of headers of a given type.

Note that some headers (e.g., Path) may be joined together with commas and appear as a single header line. This variable counts the number of header lines, not header values.

For message fragment below, $hdrcnt(Path) will have value 2 and $(hdr(Path)[0]) will have value <a.com>:

    Path: <a.com>
    Path: <b.com>

For message fragment below, $hdrcnt(Path) will have value 1 and $(hdr(Path)[0]) will have value <a.com>,<b.com>:

    Path: <a.com>,<b.com>

Note that both examples above are semantically equivalent but the variables take on different values.

3.98  Route Type - $rT 🔗

$rT - Holds the current route type as a string. Useful for determining the original route type when inside another route in script, such as a route called from an onreply_route. Allows for more generic and reusable routes such as a logging route which includes the route type in the logged message.

3.99  Current script line and file - $cfg_line 🔗

$cfg_line - Holds the current line from the script of the action being executed, useful for logging purposes
$cfg_file - Holds the current name of the cfg file being executed, useful when using multiple scripts via the include statement

3.100  Log level for xlog()

$xlog_level - allows to set /reset the xlog() logging level on per-process bases. Shortly said, you can read the verbosity level for the xlog() calls or you can temporary change the level per process bases.

Example:

xlog("current verbosity is $xlog_level \n");
$xlog_level = L_DBG; # force local xlogging limit to DBG
...
(set of xlogs)
...
$xlog_level = NULL;  # reset to initial value

4. Escape Sequences

These sequences are exported, and mainly used, by xlog module to print messages in many colors (foreground and background) using escape sequences.

4.1 Foreground and background colors

$C(xy) - reference to an escape sequence. x represents the foreground color and y represents the background color.

Colors could be:

4.2 Examples

A few examples of usage.

...
route {
...
    $avp(uuid)="caller_id";
    $avp(tmp)= $avp(uuid) + ": " + $fu;
    xlog("$C(bg)$avp(tmp)$C(xx) [$avp(tmp)] $C(br)$cs$C(xx)=[$hdr(cseq)]\n");
...
}
...
Retrieved from https://www.opensips.org/Documentation/Script-CoreVar-3-1
Page last modified on December 20, 2021, at 01:00 PM