Add sounds and update config files
[asterisk/asterisk.git] / 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 ${EPOCH}        Current unix style epoch
41 ${DATETIME}     Current date time in the format: YYYY-MM-DD_HH:MM:SS
42 ${UNIQUEID}     Current call unique identifier
43
44 There are two reference modes - reference by value and reference by name. 
45 To refer to a variable with its name (as an argument to a function that 
46 requires a variable), just write the name. To refer to the variable's value, 
47 enclose it inside ${}. For example, SetVar takes as the first argument 
48 (before the =) a variable name, so: 
49
50 ;exten => 1,2,SetVar,koko=lala
51 ;exten => 1,3,SetVar,${koko}=blabla
52
53 stores to the variable "koko" the value "lala" and to variable "lala" the 
54 value "blabla". 
55
56 In fact, everything contained ${here} is just replaced with the value of 
57 the variable "here". 
58
59 EXPRESSIONS: 
60
61 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
62 considered as an expression and it is evaluated. Evaluation works similar to 
63 (but is done on a later stage than) variable substitution: the expression 
64 (including the square brackets) is replaced by the result of the expression 
65 evaluation. The arguments and operands of the expression MUST BE separated 
66 with spaces (take care NOT to leave ANY spaces between opening and closing 
67 square brackets and the first and last arguments). 
68
69 For example, after the sequence: 
70
71 exten => 1,1,SetVar,"lala=$[1 + 2]";
72 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
73
74 the value of variable koko is "6".
75
76 Operators are listed below in order of increasing precedence.  Operators
77 with equal precedence are grouped within { } symbols.
78
79      expr1 | expr2
80              Return the evaluation of expr1 if it is neither an empty string
81              nor zero; otherwise, returns the evaluation of expr2.
82
83      expr1 & expr2
84              Return the evaluation of expr1 if neither expression evaluates to
85              an empty string or zero; otherwise, returns zero.
86
87      expr1 {=, >, >=, <, <=, !=} expr2
88              Return the results of integer comparison if both arguments are
89              integers; otherwise, returns the results of string comparison
90              using the locale-specific collation sequence.  The result of each
91              comparison is 1 if the specified relation is true, or 0 if the
92              relation is false.
93
94      expr1 {+, -} expr2
95              Return the results of addition or subtraction of integer-valued
96              arguments.
97
98      expr1 {*, /, %} expr2
99              Return the results of multiplication, integer division, or
100              remainder of integer-valued arguments.
101
102      expr1 : expr2
103              The `:' operator matches expr1 against expr2, which must be a
104              regular expression.  The regular expression is anchored to the
105              beginning of  the string with an implicit `^'.
106
107              If the match succeeds and the pattern contains at least one regu-
108              lar expression subexpression `\(...\)', the string correspond-
109              ing to `\1' is returned; otherwise the matching operator
110              returns the number of characters matched.  If the match fails and
111              the pattern contains a regular expression subexpression the null
112              string is returned; otherwise 0.
113
114 Parentheses are used for grouping in the usual manner.
115
116 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
117 produce pure parsers, which are reentrant) 
118
119 CONDITIONALS
120
121 There is one conditional operator - the conditional goto : 
122
123 ;exten => 1,2,gotoif,condition?label1:label2
124
125 If condition is true go to label1, else go to label2. Labels are interpreted
126 exactly as in the normal goto command.
127
128 "condition" is just a string. If the string is empty or "0", the condition
129 is considered to be false, if it's anything else, the condition is true. 
130 This is designed to be used together with the expression syntax described 
131 above, eg : 
132
133 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
134
135
136 Example of use : 
137
138 exten => s,2,SetVar,"vara=1"
139 exten => s,3,SetVar,"varb=$[${vara} + 2]"
140 exten => s,4,SetVar,"varc=$[${varb} * 2]"
141 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
142