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 [2018/11/23 11:53] miconda |
cookbooks:devel:pseudovariables [2020/01/22 13:23] miconda [$sndto(name)] |
||
---|---|---|---|
Line 1: | Line 1: | ||
{{ : | {{ : | ||
- | ====== Kamailio SIP Server v5.3.x (devel): Pseudo-Variables ====== | + | ====== Kamailio SIP Server v5.4.x (devel): Pseudo-Variables ====== |
===== Introduction ===== | ===== Introduction ===== | ||
Line 20: | Line 20: | ||
* avpops | * avpops | ||
* htable | * htable | ||
+ | * http_async_client | ||
* textops | * textops | ||
* uac | * uac | ||
Line 76: | Line 77: | ||
**$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 auth username ($au) if exists 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 225: | Line 228: | ||
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 278: | Line 282: | ||
**$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 849: | Line 857: | ||
<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 915: | Line 932: | ||
} | } | ||
</ | </ | ||
- | ===== 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(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Send Data Attributes ===== | ||
==== $sndfrom(name) ==== | ==== $sndfrom(name) ==== | ||
Line 934: | Line 977: | ||
* af - address family to be used to send (numeric) | * af - address family to be used to send (numeric) | ||
* port - port of destination address | * port - port of destination address | ||
- | * proto - transport protocol to be used to send (numeric) | + | * proto - transport protocol to be used to send (numeric |
* sproto - transport protocol to be used to send (string) | * sproto - transport protocol to be used to send (string) | ||
* buf - entire send buffer as string | * buf - entire send buffer as string | ||
Line 950: | Line 993: | ||
} | } | ||
</ | </ | ||
+ | |||
+ | ===== SIPDUMP Module ===== | ||
+ | |||
+ | ==== $sipdump(name) ==== | ||
+ | |||
+ | **$sipdump(name)** - return attributes of the message handled in the event_route[sipdump: | ||
+ | |||
+ | The name can be: | ||
+ | |||
+ | * tag - the tag of processing (rcv or snd) | ||
+ | * buf - entire message buffer as string | ||
+ | * len - length of the message (length of above buf) | ||
+ | * af - address family | ||
+ | * src_ip - source IP address | ||
+ | * dst_ip - destination IP address | ||
+ | * src_port - port of source address | ||
+ | * dst_port - port of source address | ||
+ | * proto - transport protocol | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | |||
+ | event_route[sipdump: | ||
+ | if($sipdump(len) > 1024) { | ||
+ | ... | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
===== Benchmark module Pseudo-Variables ===== | ===== Benchmark module Pseudo-Variables ===== | ||
Line 1088: | Line 1161: | ||
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 1311: | Line 1384: | ||
... | ... | ||
</ | </ | ||
+ | |||
+ | ===== http_async_client module Pseudo-Variables ===== | ||
+ | |||
+ | ==== $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 1666: | Line 1797: | ||
==== $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 2066: | Line 2201: | ||
===== sdpops module variables ===== | ===== sdpops module variables ===== | ||
- | * $sdp(body) - full SDP body (read only) | + | * $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) | * $sdp(sess_version) - sess-version -attribute from SDP o= -line. When set to special value -1, current value is incremented. (read + write) | ||
- | ===== kex module variables ===== | + | ===== $sruid - Unique ID ===== |
+ | |||
+ | * $sruid - return unique ID generated internally Kamailio | ||
+ | |||
+ | ===== $ltt(key) - Local To-Tag ===== | ||
+ | |||
+ | $ltt(key) - return local generated To-tag when Kamailio sends a reply | ||
+ | |||
+ | * $ltt(s) - the to-tag used in stateless replies | ||
+ | * $ltt(t) - the to-tag used in transaction stateful replies (transaction has to be created at that time, eg., by t_newtran() or in a branch/ | ||
+ | * $ltt(x) - $ltt(t) if the transaction was created already, otherwise $ltt(s) | ||
+ | |||
+ | ===== tcpops module variable ===== | ||
+ | |||
+ | $tcp(key) - return TCP connection attributes. | ||
+ | |||
+ | The key can be: | ||
+ | * c_si - connection source ip (useful with HAProxy connections) | ||
+ | * c_sp - connection source port (useful with HAProxy connections) | ||
+ | * conid - connection id | ||
+ | |||
+ | |||
+ | ===== pv_headers | ||
+ | |||
+ | * $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: | ||
- | * $sruid - return unique ID | ||
===== $C(xy) - Foreground and background colors ===== | ===== $C(xy) - Foreground and background colors ===== | ||