Agent documentation changes to agents and verbose / debug fixes (bug #3158)
[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}   Time for the call (seconds)
84 ${ANSWEREDTIME} Time from dial to answer (seconds)
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 There are two reference modes - reference by value and reference by name. 
100 To refer to a variable with its name (as an argument to a function that 
101 requires a variable), just write the name. To refer to the variable's value, 
102 enclose it inside ${}. For example, SetVar takes as the first argument 
103 (before the =) a variable name, so: 
104
105 ;exten => 1,2,SetVar,koko=lala
106 ;exten => 1,3,SetVar,${koko}=blabla
107
108 stores to the variable "koko" the value "lala" and to variable "lala" the 
109 value "blabla". 
110
111 In fact, everything contained ${here} is just replaced with the value of 
112 the variable "here". 
113
114 ___________________________
115 EXPRESSIONS: 
116 ---------------------------
117
118 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
119 considered as an expression and it is evaluated. Evaluation works similar to 
120 (but is done on a later stage than) variable substitution: the expression 
121 (including the square brackets) is replaced by the result of the expression 
122 evaluation. The arguments and operands of the expression MUST BE separated 
123 by at least one space. 
124
125
126 For example, after the sequence: 
127
128 exten => 1,1,SetVar,"lala=$[1 + 2]";
129 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
130
131 the value of variable koko is "6".
132
133 And, further:
134
135 exten => 1,1,SetVar,"lala=$[1+2]";
136
137 will not work as you might have expected. Since all the chars in the single 
138 token "1+2" are not numbers, it will be evaluated as the string "1+2". Again,
139 please do not forget, that this is a very simple parsing engine, and it
140 uses a space (at least one), to separate "tokens".
141
142 and, further:
143
144 exten => 1,1,SetVar,"lala=$[  1 +    2   ]";
145
146 will parse as intended. Extra spaces are ignored.
147
148 ___________________________
149 SPACES INSIDE VARIABLE
150 ---------------------------
151 If the variable being evaluated contains spaces, there can be problems.
152
153 For these cases, double quotes around text that may contain spaces
154 will force the surrounded text to be evaluated as a single token.
155 The double quotes will be counted as part of that lexical token.
156
157 As an example:
158
159 exten => s,6,GotoIf($[ "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
160
161 The variable CALLERIDNAME could evaluate to "DELOREAN MOTORS" (with a space)
162 but the above will evaluate to:
163
164 "DELOREAN MOTORS" : "Privacy Manager"
165
166 and will evaluate to 0.
167
168 The above without double quotes would have evaluated to:
169
170 DELOREAN MOTORS : Privacy Manager
171
172 and will result in syntax errors, because token DELOREAN is immediately
173 followed by token MOTORS and the expression parser will not know how to 
174 evaluate this expression.
175
176 _____________________
177 OPERATORS
178 ---------------------
179 Operators are listed below in order of increasing precedence.  Operators
180 with equal precedence are grouped within { } symbols.
181
182      expr1 | expr2
183              Return the evaluation of expr1 if it is neither an empty string
184              nor zero; otherwise, returns the evaluation of expr2.
185
186      expr1 & expr2
187              Return the evaluation of expr1 if neither expression evaluates to
188              an empty string or zero; otherwise, returns zero.
189
190      expr1 {=, >, >=, <, <=, !=} expr2
191              Return the results of integer comparison if both arguments are
192              integers; otherwise, returns the results of string comparison
193              using the locale-specific collation sequence.  The result of each
194              comparison is 1 if the specified relation is true, or 0 if the
195              relation is false.
196
197      expr1 {+, -} expr2
198              Return the results of addition or subtraction of integer-valued
199              arguments.
200
201      expr1 {*, /, %} expr2
202              Return the results of multiplication, integer division, or
203              remainder of integer-valued arguments.
204
205      expr1 : expr2
206              The `:' operator matches expr1 against expr2, which must be a
207              regular expression.  The regular expression is anchored to the
208              beginning of  the string with an implicit `^'.
209
210              If the match succeeds and the pattern contains at least one regu-
211              lar expression subexpression `\(...\)', the string correspond-
212              ing to `\1' is returned; otherwise the matching operator
213              returns the number of characters matched.  If the match fails and
214              the pattern contains a regular expression subexpression the null
215              string is returned; otherwise 0.
216
217 Parentheses are used for grouping in the usual manner.
218
219 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
220 produce pure parsers, which are reentrant) 
221
222 ___________________________
223 CONDITIONALS
224 ---------------------------
225
226 There is one conditional operator - the conditional goto : 
227
228 ;exten => 1,2,gotoif,condition?label1:label2
229
230 If condition is true go to label1, else go to label2. Labels are interpreted
231 exactly as in the normal goto command.
232
233 "condition" is just a string. If the string is empty or "0", the condition
234 is considered to be false, if it's anything else, the condition is true. 
235 This is designed to be used together with the expression syntax described 
236 above, eg : 
237
238 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
239
240
241 Example of use : 
242
243 exten => s,2,SetVar,"vara=1"
244 exten => s,3,SetVar,"varb=$[${vara} + 2]"
245 exten => s,4,SetVar,"varc=$[${varb} * 2]"
246 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
247
248 ___________________________
249 PARSE ERRORS
250 ---------------------------
251
252 Syntax errors are now output with 3 lines.
253
254 If the extensions.conf file contains a line like:
255
256 exten => s,6,GotoIf($[ "${CALLERIDNUM}"  = "3071234567" & "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
257
258 You may see an error in /var/log/asterisk/messages like this:
259
260 May  3 15:58:53 WARNING[1234455344]: ast_yyerror(): syntax error: parse error; Input:
261  "3072312154"  : "3071234567" & & "Steves Extension" : "Privacy Manager"
262  ^^^^^^^^^^^^^^^^^^^^^^^^^^^
263                                   ^
264
265 The first line shows the string passed to the expression parser. This
266 string is the result of the variable replacements, etc. This way, you
267 can see the actual string that went into the parser.
268
269 The second line usually shows a string of '^' chars, that show what's
270 been legally parsed so far.
271
272 And the third line shows where the parser was (lookahead token lexing,
273 etc), when the parse hit the rocks. A single '^' here. The error is
274 going to be somewhere between the last '^' on the second line, and the
275 '^' on the third line. That's right, in the example above, there are two
276 '&' chars, separated by a space, and this is a definite no-no!
277
278
279 ___________________________
280 NULL STRINGS
281 ---------------------------
282
283 Testing to see if a string is null can be done in one of two different ways:
284
285 exten => _XX.,1,GotoIf($["${calledid}" != ""]?3) 
286
287 exten => _XX.,1,GotoIf($[foo${calledid} != foo]?3) 
288
289
290 The second example above is the way suggested by the WIKI. It will 
291 work as long as there are no spaces in the evaluated value.
292
293 The first way should work in all cases, and indeed, might now
294 be the safest way to handle this situation.
295
296 ___________________________
297 WARNING
298 ---------------------------
299
300 If you need to do complicated things with strings, asterisk expressions
301 is most likely NOT the best way to go about it. AGI scripts are an
302 excellent option to this need, and make available the full power of
303 whatever language you desire, be it Perl, C, C++, Cobol, RPG, Java,
304 Snobol, PL/I, Scheme, Common Lisp, Shell scripts, Tcl, Forth, Modula,
305 Pascal, APL, assembler, etc.
306