Merge anthm's monitor fixes (better default path, set variable for monitor) (bug...
[asterisk/asterisk.git] / doc / README.variables
1 EXTENSION LOGIC : 
2
3 There are two levels of parameter evaluation done in asterisk in 
4 extensions.conf.
5 The first, and most frequently used, is the substitution of variable
6 references with their values. 
7
8 Then there are the evaluations done in $[ .. ]. This will be
9 discussed below.
10
11 ___________________________
12 PARAMETER QUOTING: 
13 ---------------------------
14
15 exten => s,5,BackGround,blabla
16
17 The parameter (blabla) can be quoted ("blabla"). In this case, a 
18 comma does not terminate the field. However, the double quotes
19 will be passed down to the Background command, in this example.
20
21 Also, characters special to variable substitution, expression evaluation, etc
22 (see below), can be quoted. For example, to literally use a $ on the 
23 string "$1231", quote it with a preceding \. Special characters that must
24 be quoted to be used, are [ ] $ " \. (to write \ itself, use \\). 
25
26 These Double quotes and escapes are evaluated at the level of the
27 asterisk config file parser. 
28
29 Double quotes can also be used inside expressions, as discussed below.
30
31
32 ___________________________
33 VARIABLES: 
34 ---------------------------
35
36 Parameter strings can include variables. Variable names are arbitrary strings. 
37 They are stored in the respective channel structure. 
38
39 To set a variable to a particular value, do : 
40
41     exten => 1,2,SetVar,varname=value
42
43 You can substitute the value of a variable everywhere using ${variablename}.
44 For example, to stringwise append $lala to $blabla and store result in $koko, 
45 do: 
46
47    exten => 1,2,SetVar,koko=${blabla}${lala}
48
49 There are also the following special variables: 
50
51 ${ACCOUNTCODE}  Account code (if specified)
52 ${CALLERID}     Caller ID
53 ${CALLERIDNAME} Caller ID Name only
54 ${CALLERIDNUM}  Caller ID Number only
55 ${CALLINGPRES}  PRI Caller ID presentation for incoming calls
56 ${CHANNEL}      Current channel name
57 ${CONTEXT}      Current context
58 ${DATETIME}     Current date time in the format: YYYY-MM-DD_HH:MM:SS
59 ${DNID}         Dialed Number Identifier
60 ${ENUM}         Result of application EnumLookup
61 ${EPOCH}        Current unix style epoch
62 ${EXTEN}        Current extension
63 ${ENV(VAR)}     Environmental variable VAR
64 ${HANGUPCAUSE}  Asterisk hangup cause
65 ${INVALID_EXTEN}The invalid called extension (used in the "i" extension)
66 ${LANGUAGE}     Current language
67 ${LEN(VAR)}     String length of VAR (integer)
68 ${MEETMESECS}   Number of seconds a user participated in a MeetMe conference
69 ${PRIORITY}     Current priority
70 ${RDNIS}        Redirected Dial Number ID Service
71 ${SIPCALLID}    SIP Call-ID: header verbatim (for logging or CDR matching)
72 ${SIPDOMAIN}    SIP destination domain of an inbound call (if appropriate)
73 ${SIPUSERAGENT} SIP user agent 
74 ${TIMESTAMP}    Current date time in the format: YYYYMMDD-HHMMSS
75 ${TXTCIDNAME}   Result of application TXTCIDName
76 ${UNIQUEID}     Current call unique identifier
77 ${PRIREDIRECTREASON} Reason for redirect, if a call was directed
78
79 The dial() application sets the following variables:
80
81 ${DIALEDPEERNAME} Dialed peer name
82 ${DIALEDPEERNUMBER} Dialed peer number
83 ${DIALEDTIME}   Total time for the call in seconds (Network time).
84 ${ANSWEREDTIME} Time from answer to end of call in seconds (Billable time).
85 ${DIALSTATUS}   Status of the call, one of:
86                 CHANUNAVAIL | CONGESTION | BUSY | NOANSWER | ANSWER | CANCEL
87
88 The agent channel uses the following variables:
89 ${AGENTMAXLOGINTRIES}   Set the maximum number of failed logins
90 ${AGENTUPDATECDR}       Whether to update the CDR record with Agent channel data
91 ${AGENTGOODBYE}         Sound file to use for "Good Bye" when agent logs out
92 ${AGENTACKCALL}         Whether the agent should acknowledge the incoming call
93 ${AGENTAUTOLOGOFF}      Auto logging off for an agent
94 ${AGENTWRAPUPTIME}      Setting the time for wrapup between incoming calls
95 ${AGENTNUMBER}          Agent number (username) set at login
96 ${AGENTSTATUS}          Status of login ( fail | on | off )
97 ${AGENTEXTEN}           Extension for logged in agent
98
99 The queue() application uses the following variables:
100 ${MONITOR_FILENAME}     File for monitoring (recording) calls in queue
101 ${QUEUE_PRIO}           Queue priority
102
103
104 The following variables can be set to change certian behaviour:
105 ${TOUCH_MONITOR}        The filename base to use with Touch Monitor (auto record)
106
107 The monitor application sets the following variable:
108 ${MONITOR}              Set to "true" if the channel is/has been monitored.
109
110 There are two reference modes - reference by value and reference by name. 
111 To refer to a variable with its name (as an argument to a function that 
112 requires a variable), just write the name. To refer to the variable's value, 
113 enclose it inside ${}. For example, SetVar takes as the first argument 
114 (before the =) a variable name, so: 
115
116 ;exten => 1,2,SetVar,koko=lala
117 ;exten => 1,3,SetVar,${koko}=blabla
118
119 stores to the variable "koko" the value "lala" and to variable "lala" the 
120 value "blabla". 
121
122 In fact, everything contained ${here} is just replaced with the value of 
123 the variable "here". 
124
125 ___________________________
126 EXPRESSIONS: 
127 ---------------------------
128
129 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
130 considered as an expression and it is evaluated. Evaluation works similar to 
131 (but is done on a later stage than) variable substitution: the expression 
132 (including the square brackets) is replaced by the result of the expression 
133 evaluation. The arguments and operands of the expression MUST BE separated 
134 by at least one space. 
135
136
137 For example, after the sequence: 
138
139 exten => 1,1,SetVar,"lala=$[1 + 2]";
140 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
141
142 the value of variable koko is "6".
143
144 And, further:
145
146 exten => 1,1,SetVar,"lala=$[1+2]";
147
148 will not work as you might have expected. Since all the chars in the single 
149 token "1+2" are not numbers, it will be evaluated as the string "1+2". Again,
150 please do not forget, that this is a very simple parsing engine, and it
151 uses a space (at least one), to separate "tokens".
152
153 and, further:
154
155 exten => 1,1,SetVar,"lala=$[  1 +    2   ]";
156
157 will parse as intended. Extra spaces are ignored.
158
159 ___________________________
160 SPACES INSIDE VARIABLE
161 ---------------------------
162 If the variable being evaluated contains spaces, there can be problems.
163
164 For these cases, double quotes around text that may contain spaces
165 will force the surrounded text to be evaluated as a single token.
166 The double quotes will be counted as part of that lexical token.
167
168 As an example:
169
170 exten => s,6,GotoIf($[ "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
171
172 The variable CALLERIDNAME could evaluate to "DELOREAN MOTORS" (with a space)
173 but the above will evaluate to:
174
175 "DELOREAN MOTORS" : "Privacy Manager"
176
177 and will evaluate to 0.
178
179 The above without double quotes would have evaluated to:
180
181 DELOREAN MOTORS : Privacy Manager
182
183 and will result in syntax errors, because token DELOREAN is immediately
184 followed by token MOTORS and the expression parser will not know how to 
185 evaluate this expression.
186
187 _____________________
188 OPERATORS
189 ---------------------
190 Operators are listed below in order of increasing precedence.  Operators
191 with equal precedence are grouped within { } symbols.
192
193      expr1 | expr2
194              Return the evaluation of expr1 if it is neither an empty string
195              nor zero; otherwise, returns the evaluation of expr2.
196
197      expr1 & expr2
198              Return the evaluation of expr1 if neither expression evaluates to
199              an empty string or zero; otherwise, returns zero.
200
201      expr1 {=, >, >=, <, <=, !=} expr2
202              Return the results of integer comparison if both arguments are
203              integers; otherwise, returns the results of string comparison
204              using the locale-specific collation sequence.  The result of each
205              comparison is 1 if the specified relation is true, or 0 if the
206              relation is false.
207
208      expr1 {+, -} expr2
209              Return the results of addition or subtraction of integer-valued
210              arguments.
211
212      expr1 {*, /, %} expr2
213              Return the results of multiplication, integer division, or
214              remainder of integer-valued arguments.
215
216      expr1 : expr2
217              The `:' operator matches expr1 against expr2, which must be a
218              regular expression.  The regular expression is anchored to the
219              beginning of  the string with an implicit `^'.
220
221              If the match succeeds and the pattern contains at least one regu-
222              lar expression subexpression `\(...\)', the string correspond-
223              ing to `\1' is returned; otherwise the matching operator
224              returns the number of characters matched.  If the match fails and
225              the pattern contains a regular expression subexpression the null
226              string is returned; otherwise 0.
227
228 Parentheses are used for grouping in the usual manner.
229
230 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
231 produce pure parsers, which are reentrant) 
232
233 ___________________________
234 CONDITIONALS
235 ---------------------------
236
237 There is one conditional operator - the conditional goto : 
238
239 ;exten => 1,2,gotoif,condition?label1:label2
240
241 If condition is true go to label1, else go to label2. Labels are interpreted
242 exactly as in the normal goto command.
243
244 "condition" is just a string. If the string is empty or "0", the condition
245 is considered to be false, if it's anything else, the condition is true. 
246 This is designed to be used together with the expression syntax described 
247 above, eg : 
248
249 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
250
251
252 Example of use : 
253
254 exten => s,2,SetVar,"vara=1"
255 exten => s,3,SetVar,"varb=$[${vara} + 2]"
256 exten => s,4,SetVar,"varc=$[${varb} * 2]"
257 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
258
259 ___________________________
260 PARSE ERRORS
261 ---------------------------
262
263 Syntax errors are now output with 3 lines.
264
265 If the extensions.conf file contains a line like:
266
267 exten => s,6,GotoIf($[ "${CALLERIDNUM}"  = "3071234567" & "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
268
269 You may see an error in /var/log/asterisk/messages like this:
270
271 May  3 15:58:53 WARNING[1234455344]: ast_yyerror(): syntax error: parse error; Input:
272  "3072312154"  : "3071234567" & & "Steves Extension" : "Privacy Manager"
273  ^^^^^^^^^^^^^^^^^^^^^^^^^^^
274                                   ^
275
276 The first line shows the string passed to the expression parser. This
277 string is the result of the variable replacements, etc. This way, you
278 can see the actual string that went into the parser.
279
280 The second line usually shows a string of '^' chars, that show what's
281 been legally parsed so far.
282
283 And the third line shows where the parser was (lookahead token lexing,
284 etc), when the parse hit the rocks. A single '^' here. The error is
285 going to be somewhere between the last '^' on the second line, and the
286 '^' on the third line. That's right, in the example above, there are two
287 '&' chars, separated by a space, and this is a definite no-no!
288
289
290 ___________________________
291 NULL STRINGS
292 ---------------------------
293
294 Testing to see if a string is null can be done in one of two different ways:
295
296 exten => _XX.,1,GotoIf($["${calledid}" != ""]?3) 
297
298 exten => _XX.,1,GotoIf($[foo${calledid} != foo]?3) 
299
300
301 The second example above is the way suggested by the WIKI. It will 
302 work as long as there are no spaces in the evaluated value.
303
304 The first way should work in all cases, and indeed, might now
305 be the safest way to handle this situation.
306
307 ___________________________
308 WARNING
309 ---------------------------
310
311 If you need to do complicated things with strings, asterisk expressions
312 is most likely NOT the best way to go about it. AGI scripts are an
313 excellent option to this need, and make available the full power of
314 whatever language you desire, be it Perl, C, C++, Cobol, RPG, Java,
315 Snobol, PL/I, Scheme, Common Lisp, Shell scripts, Tcl, Forth, Modula,
316 Pascal, APL, assembler, etc.
317