$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). In addition, it also supports the forced sub-field, which returns a socket description only if a socket had been explicitly forced; thus, as opposed to the regular $socket_out, if no socket had explicitly been forced, the variable returns NULL.

Authorize Challenge Algorithm - $challenge.algorithm 🔗

$challenge.algorithm - the algorithm value taken from the WWW-Authorize or Proxy-Authorize header.

Authorize Challenge Realm - $challenge.realm 🔗

$challenge.realm - the realm value taken from the WWW-Authorize or Proxy-Authorize header.

Authorize Challenge Nonce - $challenge.nonce 🔗

$challenge.nonce - the nonce value taken from the WWW-Authorize or Proxy-Authorize header.

Authorize Challenge Opaque - $challenge.opaque 🔗

$challenge.opaque - the opaque value taken from the WWW-Authorize or Proxy-Authorize header.

Authorize Challenge QOP - $challenge.qop 🔗

$challenge.qop - the qop value taken from the WWW-Authorize or Proxy-Authorize header.

Authorize Challenge IK - $challenge.ik 🔗

$challenge.ik - the ik value taken from the WWW-Authorize or Proxy-Authorize header.

Authorize Challenge CK - $challenge.ck 🔗

$challenge.ck - the ck value taken from the WWW-Authorize or Proxy-Authorize header.

Return value - $return 🔗

$return - Returns the value of the previously executed route.

The variable receives an index, starting with 0, indicating the return value that needs to be read.

Return value of previously executed route - $return 🔗

Return value of previously executed route 🔗

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

   $socket_out = "udp:11.11.11.11:5060";

Route Name (Full) - $route 🔗

Route Name - $route.name 🔗

Route Type - $route.type 🔗

$route.type - Access the type of the current route. May be indexed, using positive or negative indexes.

• $route.type and $(route.type[0]) both return current route type
• $(route.type[1]) returns parent route type
• $(route.type[-1]) returns topmost route type
• $(route.type[-2]) returns next-topmost route type

Route Name - $route.name 🔗

$route.name - Access the name of the current route. May be indexed, using positive or negative indexes.

• $route.name and $(route.name[0]) both return current route name
• $(route.name[1]) returns parent route name
• $(route.name[-1]) returns topmost route name
• $(route.name[-2]) returns next-topmost route name

Fields of a contact instance - $ct.fields 🔗

Script variables 🔗

AVP variables 🔗

Scripting Variables 🔗

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

Authentication Digest URI - $adu 🔗

Authentication realm - $ar 🔗

Auth username user - $au 🔗

Auth username domain - $ad 🔗

Auth nonce - $an 🔗

Auth response - $auth.resp 🔗

Auth nonce - $auth.nonce 🔗

Auth opaque - $auth.opaque 🔗

Auth algorithm - $auth.alg 🔗

Auth QOP - $auth.qop 🔗

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

Auth whole username - $aU 🔗

Acc username - $Au 🔗

Argument options - $argv 🔗

Branch flags list - $bf 🔗

Branch - $branch 🔗

Branch fields - $branch.fields 🔗

Branch flag - $branch.flag 🔗

Call-Id - $ci 🔗

Content-Length - $cl 🔗

CSeq number - $cs 🔗

Contact instance - $ct 🔗

Fields of a contact instance - $ct.dields 🔗

Content-Type - $cT 🔗

Domain of destination URI - $dd 🔗

Diversion header URI - $di 🔗

Diversion "privacy" parameter - $dip 🔗

Diversion "reason" parameter - $dir 🔗

Port of destination URI - $dp 🔗

Transport protocol of destination URI - $dP 🔗

Destination set - $ds 🔗

Destination URI - $du 🔗

Error class - $err.class 🔗

Error level - $err.level 🔗

Error info - $err.info 🔗

Error reply code - $err.rcode 🔗

Error reply reason - $err.rreason 🔗

From URI domain - $fd 🔗

From display name - $fn 🔗

From tag - $ft 🔗

From URI - $fu 🔗

From URI username - $fU 🔗

OpenSIPS Log level - $log_level 🔗

Message Flags - $mf 🔗

SIP message ID - $mi 🔗

SIP message length - $ml 🔗

Message flag - $msg.flag 🔗

Message is request - $msg.is_request 🔗

Message type - $msg.type 🔗

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

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

Transport protocol of SIP request original URI - $oP 🔗

SIP Request's original URI - $ou 🔗

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

Route parameter - $param 🔗

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

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

Process id - $pp 🔗

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

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

Domain in SIP Request's URI - $rd 🔗

Body of request/reply - $rb 🔗

Returned code - $rc 🔗

Remote-Party-ID header URI - $re 🔗

SIP request's method - $rm 🔗

SIP request's port - $rp 🔗

Transport protocol of SIP request URI - $rP 🔗

SIP reply's reason - $rr 🔗

SIP reply's status - $rs 🔗

Refer-to URI - $rt 🔗

SIP Request's URI - $ru 🔗

Username in SIP Request's URI - $rU 🔗

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

IP source address - $si 🔗

Socket inbound - $socket_in 🔗

Socket outbound - $socket_out 🔗

Source port - $sp 🔗

To URI Domain - $td 🔗

To display name - $tn 🔗

To tag - $tt 🔗

To URI - $tu 🔗

To URI Username - $tU 🔗

Formatted date and time - $time 🔗

Branch index - $T_branch_idx 🔗

String formatted time - $Tf 🔗

Current unix time stamp in seconds - $Ts 🔗

Current microseconds of the current second - $Tsm 🔗

Startup unix time stamp - $TS 🔗

User agent header - $ua 🔗

SIP Headers - $hdr 🔗

Route Name - $route 🔗

Current script line and file - $cfg_line 🔗

Log level for xlog() - $xlog_level 🔗

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

Authentication Digest URI 🔗

Authentication realm 🔗

Auth username user 🔗

Auth username domain 🔗

Auth nonce 🔗

Auth response 🔗

Auth nonce 🔗

Auth opaque 🔗

Auth algorithm 🔗

Auth QOP 🔗

Auth nonce count (nc) 🔗

Auth whole username 🔗

Acc username 🔗

Argument options 🔗

Branch flags list 🔗

Branch 🔗

Branch fields 🔗

Branch flag 🔗

Call-Id 🔗

Content-Length 🔗

CSeq number 🔗

Contact instance 🔗

Fields of a contact instance 🔗

Content-Type 🔗

Domain of destination URI 🔗

Diversion header URI 🔗

Diversion "privacy" parameter 🔗

Diversion "reason" parameter 🔗

Port of destination URI 🔗

Transport protocol of destination URI 🔗

Destination set 🔗

Destination URI 🔗

Error class 🔗

Error level 🔗

Error info 🔗

Error reply code 🔗

Error reply reason 🔗

From URI domain 🔗

From display name 🔗

From tag 🔗

From URI 🔗

From URI username 🔗

OpenSIPS Log level 🔗

Message Flags 🔗

SIP message ID 🔗

SIP message length 🔗

Message flag 🔗

Message is request 🔗

Message type 🔗

Domain in SIP Request's original URI 🔗

Port of SIP request's original URI 🔗

Transport protocol of SIP request original URI 🔗

SIP Request's original URI 🔗

Username in SIP Request's original URI 🔗

Route parameter 🔗

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

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

Process id 🔗

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

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

Domain in SIP Request's URI 🔗

Body of request/reply 🔗

Returned code 🔗

Remote-Party-ID header URI 🔗

SIP request's method 🔗

SIP request's port 🔗

Transport protocol of SIP request URI 🔗

SIP reply's reason 🔗

SIP reply's status 🔗

Refer-to URI 🔗

SIP Request's URI 🔗

Username in SIP Request's URI 🔗

Q value of the SIP Request's URI 🔗

IP source address 🔗

Socket inbound 🔗

Socket outbound 🔗

Source port 🔗

To URI Domain 🔗

To display name 🔗

To tag 🔗

To URI 🔗

To URI Username 🔗

Formatted date and time 🔗

Branch index 🔗

String formatted time 🔗

Current unix time stamp in seconds 🔗

Current microseconds of the current second 🔗

Startup unix time stamp 🔗

User agent header 🔗

SIP Headers 🔗

Route Name 🔗

Current script line and file 🔗

Log level for xlog() 🔗

@]

• $route and $(route[0]) both return "route[B]" (current route)

• $(route[-3]) returns "route[B]" (next-next-topmost route)
• $(route[3]) and $(route[-4]) both return NULL (index out of bounds)

• $(route[2]) returns "route" (previous-parent route)

• $(route[*]) returns "route > route[A] > route[B]" (entire call stack)

$route - Access route names of the current route call stack. Usage examples (assuming a route call stack of "route > route[A] > route[B]"):

• $(route[*]) returns "route > route[A] > route[B]"

$route - Access route names of the current route call stack. Usage examples (assuming a route call stack of "route -> route[A] -> route[B]"):

• $(route[3]) and $(route[-4]) return NULL (index out of bounds)

$route - Access the current route call stack. Usage examples (assuming a route call stack of "route -> route[A] -> route[B]"):

• $route, $(route[0]), $(route[-3]) all return: "route[B]" (current route)
• $(route[1]) returns "route[A]" (parent route)

• $(route[-2]) returns "route[A]" (next-topmost route)
• $(route[3]) and $(route[-4]) return NULLL (index out of bounds)

Route Name

$route - Access the current route call stack. Usage examples (assuming a route call stack of "route -> A -> B"):

• $route, $(route[0]), $(route[-3]) all return: "B" (current route)
• $(route[1]) returns "A" (parent route)
• $(route[-1]) returns "route" (topmost route)
• $(route[-2]) returns "A" (next-topmost route)

1. a script variable can only hold one value.

Branch flags list

Message 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");

Message 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");

Branch flags mask

$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.

Message 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");

$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:

Branch flag

$branch.flag(flag_name)[] - this variable provides read/write access to the value of a 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");

Address family (Obsoleted with OpenSIPS 3.6)

Use $socket_in(af) instead.

• af - the address family of the socket's IP. It's value is "INET" if IPv4 or "INET6" if IPv6.

Use $socket_out instead.

Protocol of received message (Obsoleted with OpenSIPS 3.6)

Use $socket_in(proto) instead.

Received IP address (Obsoleted with OpenSIPS 3.6)

Use $socket_in(ip) instead.

Received port (Obsoleted with OpenSIPS 3.6)

Use $socket_in(port) instead.

1. Multiple values example

Scripting Variables

$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");

Socket inbound

$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:

• ip - the IP part of the socket
• port - the port part of the socket
• proto - the name of the protocol of the socket (as "UDP", "TPC", etc)
• advertised_ip - the advertised IP part of the socket (it may be NULL if no advertising is done on this particlar socket)
• advertised_port - the advertised part part of the socket (it may be NULL if no advertising is done on this particlar socket)
• tag - the socket internal tag/alias
• anycast - if the socket uses an anycast IP or not (returns 0 if not, 1 if yes)

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

Socket outbound

$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.

Forced socket (Obsoleted with OpenSIPS 3.6)

See $socket_out

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.

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

$(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.

(:toc-float Table of Contents:)

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

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

Address family

$af - The address family of the received SIP message. It's value is "INET" if the message was received over IPv4 or "INET6" if the message was received over IPv6.

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

• $rb - the whole body of the message (with all the parts)

• $rb(application/sdp) - get the first SDP body part
• $(rb(application/isup)[-1]) - get the last ISUP body part

AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).
A special index append is defined to allow you to add a new value at the end of the list (at the bottom of the stack) - $(avp(name)[append]) = "last value";

Log level in xlog

$xlog_level - holds the string expansion of the log level of the xlog message Example:

xlog("$xlog_level some text\n")

will generate:

ERROR: some text

OpenSIPS 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
      .......
    }

Script flags (Removed in OpenSIPS 3.6)

$sf - displays a list with the script flags set for the current SIP request

$cfg_line - Holds the current line from the script of the action being executed, useful for logging purposes \\

Current script line and file

$cfg_line - Holds the current line 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

$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP, WS)

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

• $cT - the main Content-Type of the message; the one inside the headers
• $(cT[n]) - the n-th Content-Type inside a multi-part body from the beginning of message, starting with index 0
• $(cT[-n]) - the n-th Content-Type inside a multi-part body from the end of the message, starting with index -1 (the last contact instance)
• $(cT[*]) - all the Content-Type headers including the main one and the ones from the multi-part body