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