95485ba7fbb1bc53fadceb924e3731b5b12819ba
[asterisk/asterisk.git] / doc / README.variables
1 GENERAL ENCHANCEMENTS TO EXTENSION LOGIC : 
2
3 QUOTING: 
4
5 exten => s,5,BackGround,blabla
6
7 The parameter (blabla) can be quoted ("blabla"). In this case, a 
8 comma does not terminate the field. 
9
10 Also, characters special to variable substitution, expression evaluation, etc
11 (see below), can be quoted. For example, to literally use a $ on the 
12 string "$1231", quote it with a preceeding \. Special characters that must
13 be quoted to be used, are [ ] $ " \. (to write \ itself, use \\). 
14
15 VARIABLES: 
16
17 Parameter strings can include variables. Variable names are arbitrary strings. 
18 They are stored in the respective channel structure. 
19
20 To set a variable to a particular value, do : 
21
22 ;exten => 1,2,SetVar,varname=value
23
24 You can substitute the value of a variable everywhere using ${variablename}.
25 For example, to stringwise append $lala to $blabla and store result in $koko, 
26 do: 
27
28 ;exten => 1,2,SetVar,koko=${blabla}${lala}
29
30 There are also the following special variables: 
31
32 ${CALLERID}     Caller ID
33 ${CALLERIDNAME} Caller ID Name only
34 ${CALLERIDNUM}  Caller ID Number only
35 ${EXTEN}        Current extension
36 ${CONTEXT}      Current context
37 ${PRIORITY}     Current priority
38 ${CHANNEL}      Current channel name
39 ${ENV(VAR)}     Environmental variable VAR
40 ${LEN(VAR)}     String length of VAR (integer)
41 ${EPOCH}        Current unix style epoch
42 ${DATETIME}     Current date time in the format: YYYY-MM-DD_HH:MM:SS
43 ${UNIQUEID}     Current call unique identifier
44 ${DNID}         Dialed Number Identifier
45 ${RDNIS}        Redirected Dial Number ID Service
46 ${HANGUPCAUSE}  Hangup cause on last PRI hangup
47 ${SIPDOMAIN}    SIP destination domain of an inbound call (if appropriate)
48
49 There are two reference modes - reference by value and reference by name. 
50 To refer to a variable with its name (as an argument to a function that 
51 requires a variable), just write the name. To refer to the variable's value, 
52 enclose it inside ${}. For example, SetVar takes as the first argument 
53 (before the =) a variable name, so: 
54
55 ;exten => 1,2,SetVar,koko=lala
56 ;exten => 1,3,SetVar,${koko}=blabla
57
58 stores to the variable "koko" the value "lala" and to variable "lala" the 
59 value "blabla". 
60
61 In fact, everything contained ${here} is just replaced with the value of 
62 the variable "here". 
63
64 EXPRESSIONS: 
65
66 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
67 considered as an expression and it is evaluated. Evaluation works similar to 
68 (but is done on a later stage than) variable substitution: the expression 
69 (including the square brackets) is replaced by the result of the expression 
70 evaluation. The arguments and operands of the expression MUST BE separated 
71 with spaces (take care NOT to leave ANY spaces between opening and closing 
72 square brackets and the first and last arguments). 
73
74 For example, after the sequence: 
75
76 exten => 1,1,SetVar,"lala=$[1 + 2]";
77 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
78
79 the value of variable koko is "6".
80
81 Operators are listed below in order of increasing precedence.  Operators
82 with equal precedence are grouped within { } symbols.
83
84      expr1 | expr2
85              Return the evaluation of expr1 if it is neither an empty string
86              nor zero; otherwise, returns the evaluation of expr2.
87
88      expr1 & expr2
89              Return the evaluation of expr1 if neither expression evaluates to
90              an empty string or zero; otherwise, returns zero.
91
92      expr1 {=, >, >=, <, <=, !=} expr2
93              Return the results of integer comparison if both arguments are
94              integers; otherwise, returns the results of string comparison
95              using the locale-specific collation sequence.  The result of each
96              comparison is 1 if the specified relation is true, or 0 if the
97              relation is false.
98
99      expr1 {+, -} expr2
100              Return the results of addition or subtraction of integer-valued
101              arguments.
102
103      expr1 {*, /, %} expr2
104              Return the results of multiplication, integer division, or
105              remainder of integer-valued arguments.
106
107      expr1 : expr2
108              The `:' operator matches expr1 against expr2, which must be a
109              regular expression.  The regular expression is anchored to the
110              beginning of  the string with an implicit `^'.
111
112              If the match succeeds and the pattern contains at least one regu-
113              lar expression subexpression `\(...\)', the string correspond-
114              ing to `\1' is returned; otherwise the matching operator
115              returns the number of characters matched.  If the match fails and
116              the pattern contains a regular expression subexpression the null
117              string is returned; otherwise 0.
118
119 Parentheses are used for grouping in the usual manner.
120
121 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
122 produce pure parsers, which are reentrant) 
123
124 CONDITIONALS
125
126 There is one conditional operator - the conditional goto : 
127
128 ;exten => 1,2,gotoif,condition?label1:label2
129
130 If condition is true go to label1, else go to label2. Labels are interpreted
131 exactly as in the normal goto command.
132
133 "condition" is just a string. If the string is empty or "0", the condition
134 is considered to be false, if it's anything else, the condition is true. 
135 This is designed to be used together with the expression syntax described 
136 above, eg : 
137
138 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
139
140
141 Example of use : 
142
143 exten => s,2,SetVar,"vara=1"
144 exten => s,3,SetVar,"varb=$[${vara} + 2]"
145 exten => s,4,SetVar,"varc=$[${varb} * 2]"
146 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
147