Manual › Reference

Keywords

Before a message is sent, every keyword in it is replaced with its value. Keywords are written in square brackets. To send a real ‘[’ (for example in an IPv6 address) write it twice: [[.

Keyword	Replaced with
`[authentication]`	A complex keyword that takes a user name and a password: `[authentication username=value1; password=value2;]`. It is replaced with an Authorization (or Proxy-Authorization) header with the MD5 digest calculated for that user name and password. If the previous message is not a 401 or 407 nothing happens. The values may be keywords: `username=[authUsername]; password=[authPassword];`.
`[authUsername]`	The authentication user name of the Account section (or `-au`).
`[authPassword]`	The authentication password of the Account section (or `-ap`).
`[branch]`	The branch parameter of the Via header: “z9hG4bK”, the call counter and the position of the entry in the scenario. For example z9hG4bK15.
`[call_number]`	The global call counter. It grows with every new call. A new dialog of the same call gets a new value too, as the suffix after a dash.
`[CCnt]`	The number of calls that run now.
`[cseq]`	The current CSeq value of this call.
`[cseq+N], [cseq-N]`	Adds N to (subtracts N from) the CSeq value of the call and is replaced with the new value. The next [cseq] has the new value too. An INVITE written with [cseq+1] and the ACK with [cseq] have the same number.
`[IP_ver]`	IP4 or IP6, as the IP version of the initial screen says. Used in the SDP.
`[fieldN]`	A value of the values file. N is the 0-based index of the column. The first call reads the first row, the second call the second row, and so on (see Values files: one scenario, many users).
`[fromUsername]`	The From of the Account section (or `-uf`).
`[toUsername]`	The To of the Account section (or `-ut`).
`[last_*:]`	Used to build responses. Replaced with the header(s) of that name of the last received message; * is the header name. `[last_Via:]` gives all Via headers of the previous message.
`[val_last_*:]`	The value of a header of the last received message, without the name. For example RAck: `[val_last_RSeq:] [val_last_CSeq:]` when working with PRACK.
`[len]`	The length of the body of the message in bytes.
`[local_ip]`	The local IP address. An IPv6 address is in square brackets. (`-lip`)
`[local_ip_sdp]`	The local IP address for the SDP: an IPv6 address is not in square brackets.
`[local_port]`	The local signalling port the message is sent from (`-lp`). For TCP and TLS, where a client uses an ephemeral port, it is the port that is really used.
`[media_port]`	The RTP port of the RTP field of the Account section: where RTP is received and sent from (`-lrtp`).
`[video_port]`	The port that the program opened for the video of this call. Used in the video line of the SDP.
`[peer_tag_param]`	The From tag, if the previously received message is a request, or the To tag, if it is a response; empty when there is none.
`[remote_ip]`	The IP address of the remote server or, in server mode, of the address the last message came from. An IPv6 address is in square brackets. (`-rip`)
`[remote_port]`	The remote server port or, in server mode, the port the last message came from (`-rp`).
`[transport]`	UDP, TCP, WS, WSS or TLS, as selected.
`[$var]`	The value of the user variable ‘var’ (see Variables).
`[$var+N], [$var-N]`	The value of ‘var’; the variable is then increased (decreased) by N, so the next reference gets the new value.
`[ver]`	The SIP Inspector version.
`[hex]...[/hex]`	Hexadecimal digits in a body, sent as bytes.
`[no_\r\n]`	At the end of a body: do not add \r\n after it.
`[[`	A literal ‘[’.

Tip: A keyword that the program does not know is left in the message as it is. If a message shows a keyword like [fromUsername] on the wire, check the spelling.