Add a new dialplan function, DIALPLAN_EXISTS(), which allows you to check for
[asterisk/asterisk.git] / CHANGES
1 ------------------------------------------------------------------------------
2 --- Functionality changes since Asterisk 1.4-beta was branched ----------------
3 -------------------------------------------------------------------------------
4
5 AMI - The manager (TCP/TLS/HTTP)
6 --------------------------------
7   * Manager has undergone a lot of changes, all of them documented
8     in doc/manager_1_1.txt
9   * Manager version has changed to 1.1
10   * Added a new action 'CoreShowChannels' to list currently defined channels
11      and some information about them. 
12   * Added a new action 'SIPshowregistry' to list SIP registrations.
13   * Added TLS support for the manager interface and HTTP server
14   * Added the URI redirect option for the built-in HTTP server
15   * The output of CallerID in Manager events is now more consistent.
16      CallerIDNum is used for number and CallerIDName for name.
17   * Enable https support for builtin web server.
18      See configs/http.conf.sample for details.
19   * Added a new action, GetConfigJSON, which can return the contents of an
20      Asterisk configuration file in JSON format.  This is intended to help
21      improve the performance of AJAX applications using the manager interface
22      over HTTP.
23   * SIP and IAX manager events now use "ChannelType" in all cases where we 
24      indicate channel driver. Previously, we used a mixture of "Channel"
25      and "ChannelDriver" headers.
26   * Added a "Bridge" action which allows you to bridge any two channels that
27      are currently active on the system.
28   * Added a "ListAllVoicemailUsers" action that allows you to get a list of all
29      the voicemail users setup.
30   * Added 'DBDel' and 'DBDelTree' manager commands.
31   * cdr_manager now reports events via the "cdr" level, separating it from
32      the very verbose "call" level.
33   * Manager users are now stored in memory. If you change the manager account
34     list (delete or add accounts) you need to reload manager.
35   * Added Masquerade manager event for when a masquerade happens between
36      two channels.
37   * Added "manager reload" command for the CLI
38
39 Dialplan functions
40 ------------------
41   * Added the DEVICE_STATE() dialplan function which allows retrieving any device
42     state in the dialplan, as well as creating custom device states that are
43     controllable from the dialplan.
44   * Extend CALLERID() function with "pres" and "ton" parameters to
45      fetch string representation of calling number presentation indicator
46      and numeric representation of type of calling number value.
47   * MailboxExists converted to dialplan function
48   * A new option to Dial() for telling IP phones not to count the call
49     as "missed" when dial times out and cancels.
50   * Added LOCK(), TRYLOCK(), and UNLOCK(), which provide a single level dialplan
51     mutex.  No deadlocks are possible, as LOCK() only allows a single lock to be
52     held for any given channel.  Also, locks are automatically freed when a
53     channel is hung up.
54   * Added HINT() dialplan function that allows retrieving hint information.
55     Hints are mappings between extensions and devices for the sake of 
56     determining the state of an extension.  This function can retrieve the list
57     of devices or the name associated with a hint.
58   * Added EXTENSION_STATE() dialplan function which allows retrieving the state
59     of any extension.
60   * Added SYSINFO() dialplan function which allows retrieval of system information
61
62 CLI Changes
63 -----------
64   * New CLI command "core show hint" (usage: core show hint <exten>)
65   * New CLI command "core show settings"
66   * Added 'core show channels count' CLI command.
67   * Added the ability to set the core debug and verbose values on a per-file basis.
68   * Added 'queue pause member' and 'queue unpause member' CLI commands
69   * Ability to set process limits ("ulimit") without restarting Asterisk
70   * Enhanced "agi debug" to print the channel name as a prefix to the debug
71      output to make debugging on busy systems much easier.
72   * New CLI commands "dialplan set extenpatternmatching true/false"
73
74 SIP changes
75 -----------
76   * Improved NAT and STUN support.
77      chan_sip now can use port numbers in bindaddr, externip and externhost
78      options, as well as contact a STUN server to detect its external address
79      for the SIP socket. See sip.conf.sample, 'NAT' section.
80   * The default SIP useragent= identifier now includes the Asterisk version
81   * A new option, match_auth_username in sip.conf changes the matching of incoming requests.
82      If set, and the incoming request carries authentication info,
83      the username to match in the users list is taken from the Digest header
84      rather than from the From: field. This feature is considered experimental.
85   * The "musiconhold" and "musicclass" settings in sip.conf are now removed,
86      since they where replaced by "mohsuggest" and "mohinterpret" in version 1.4
87   * The "localmask" setting was removed in version 1.2 and the reminder about it
88      being removed is now also removed.
89   * A new option "busylevel" for setting a level of calls where asterisk reports
90      a device as busy, to separate it from call-limit. This value is also added
91      to the SIP_PEER dialplan function.
92   * A new realtime family called "sipregs" is now supported to store SIP registration
93      data. If this family is defined, "sippeers" will be used for configuration and
94      "sipregs" for registrations. If it's not defined, "sippeers" will be used for
95      registration data, as before.
96   * The SIPPEER function have new options for port address, call and pickup groups
97   * Added support for T.140 realtime text in SIP/RTP
98   * The "checkmwi" option has been removed from sip.conf, as it is no longer
99      required due to the restructuring of how MWI is handled.  See the descriptions 
100      in this file of the "pollmailboxes" and "pollfreq" options to voicemail.conf 
101      for more information.
102   * Added rtpdest option to CHANNEL() dialplan function.
103   * Added SIPREFERRINGCONTEXT and SIPREFERREDBYHDR variables which are set when a transfer takes place.
104   * SIP now adds a header to the CANCEL if the call was answered by another phone
105      in the same dial command, or if the new c option in dial() is used.
106   * The new default is that 100 Trying is not sent on REGISTER attempts as the RFC specifically
107      states it is not needed. For phones, however, that do require it the "registertrying" option
108      has been added so it can be enabled. 
109   * A new option called "callcounter" (global/peer/user level) enables call counters needed
110     for better status reports needed for queues and SIP subscriptions. (Call-Limit was previously
111     used to enable this functionality).
112   * New settings for timer T1 and timer B on a global level or per device. This makes it 
113     possible to force timeout faster on non-responsive SIP servers. These settings are
114     considered advanced, so don't use them unless you have a problem.
115   * Added a dial string option to be able to set the To: header in an INVITE to any
116     SIP uri.
117
118 IAX2 changes
119 ------------
120   * Added the trunkmaxsize configuration option to chan_iax2.
121   * Added the srvlookup option to iax.conf
122   * Added support for OSP.  The token is set and retrieved through the CHANNEL()
123      dialplan function.
124
125 XMPP Google Talk/Jingle changes
126 -------------------------------
127   * Added the bindaddr option to gtalk.conf.
128
129 Skinny changes
130 -------------
131   * Added skinny show device, skinny show line, and skinny show settings CLI commands.
132   * Proper codec support in chan_skinny.
133   * Added settings for IP and Ethernet QoS requests
134
135 MGCP changes
136 ------------
137   * Added separate settings for media QoS in mgcp.conf
138
139 OSS Channel changes
140 -------------------
141   * Added experimental support for video under X windows
142
143 Phone channel changes (chan_phone)
144 ----------------------------------
145   * Added G729 passthrough support to chan_phone for Sigma Designs boards.
146
147 H.323 channel Changes
148 ---------------------
149   * H323 remote hold notification support added (by NOTIFY message
150      and/or H.450 supplementary service)
151
152 Local channel changes
153 ---------------------
154   * The device state functionality in the Local channel driver has been updated
155      to indicate INUSE or NOT_INUSE when a Local channel is being used as opposed
156      to just UNKNOWN if the extension exists.
157   * Added jitterbuffer support for chan_local.  This allows you to use the
158      generic jitterbuffer on incoming calls going to Asterisk applications.
159      For example, this would allow you to use a jitterbuffer for an incoming
160      SIP call to Voicemail by putting a Local channel in the middle.  This
161      feature is enabled by using the 'j' option in the Dial string to the Local
162      channel in conjunction with the existing 'n' option for local channels.
163
164 Zaptel channel driver (chan_zap) Changes
165 ----------------------------------------
166   * SS7 support in chan_zap (via libss7 library)
167   * In India, some carriers transmit CID via dtmf. Some code has been added
168     that will handle some situations. The cidstart=polarity_IN choice has been added for
169     those carriers that transmit CID via dtmf after a polarity change.
170   * CID matching information is now shown when doing 'dialplan show'.
171   * Added zap show version CLI command to chan_zap.
172   * Added setvar support to zapata.conf channel entries.
173   * Added two new options: mwimonitor and mwimonitornotify.  These options allow
174      you to enable MWI monitoring on FXO lines.  When the MWI state changes,
175      the script specified in the mwimonitornotify option is executed.  An internal
176          event indicating the new state of the mailbox is also generated, so that
177          the normal MWI facilities in Asterisk work as usual.
178
179 A new channel driver: Unistim
180 -----------------------------
181   * Added a new channel driver, chan_unistim.  See doc/unistim.txt and
182      configs/unistim.conf.sample for details.  This new channel driver allows
183      you to use Nortel i2002, i2004, and i2050 phones with Asterisk.
184  
185 DUNDi changes
186 -------------
187   * Added the ability to specify arguments to the Dial application when using
188      the DUNDi switch in the dialplan.
189   * Added the ability to set weights for responses dynamically.  This can be
190      done using a global variable or a dialplan function.  Using the SHELL()
191      function would allow you to have an external script set the weight for
192      each response.
193   * Added two new dialplan functions, DUNDIQUERY and DUNDIRESULT.  These
194      functions will allow you to initiate a DUNDi query from the dialplan,
195      find out how many results there are, and access each one.
196
197 ENUM changes
198 ------------
199   * Added two new dialplan functions, ENUMQUERY and ENUMRESULT.  These
200      functions will allow you to initiate an ENUM lookup from the dialplan,
201      and Asterisk will cache the results.  ENUMRESULT can be used to access
202      the results without doing multiple DNS queries.
203
204 Voicemail Changes
205 -----------------
206   * Added the ability to customize which sound files are used for some of the
207      prompts within the Voicemail application by changing them in voicemail.conf
208   * Added the ability for the "voicemail show users" CLI command to show users
209      configured by the dynamic realtime configuration method.
210   * MWI (Message Waiting Indication) handling has been significantly
211      restructured internally to Asterisk.  It is now totally event based
212      instead of polling based.  The voicemail application will notify other
213      modules that have subscribed to MWI events when something in the mailbox
214      changes.
215     This also means that if any other entity outside of Asterisk is changing
216      the contents of mailboxes, then the voicemail application still needs to
217      poll for changes.  Examples of situations that would require this option
218      are web interfaces to voicemail or an email client in the case of using
219      IMAP storage.  So, two new options have been added to voicemail.conf
220      to account for this: "pollmailboxes" and "pollfreq".  See the sample
221      configuration file for details.
222   * Added "tw" language support
223   * Added support for storage of greetings using an IMAP server
224   * Added ability to customize forward, reverse, stop, and pause keys for message playback
225   * SMDI is now enabled in voicemail using the smdienable option.
226   * A "lockmode" option has been added to asterisk.conf to configure the file
227      locking method used for voicemail, and potentially other things in the
228      future.  The default is the old behavior, lockfile.  However, there is a
229      new method, "flock", that uses a different method for situations where the
230      lockfile will not work, such as on SMB/CIFS mounts.
231
232 Queue changes
233 -------------
234   * Added the general option 'shared_lastcall' so that member's wrapuptime may be
235      used across multiple queues.
236   * Added QUEUE_VARIABLES function to set queue variables added setqueuevar and 
237      setqueueentryvar options for each queue, see queues.conf.sample for details.
238   * Added keepstats option to queues.conf which will keep queue
239      statistics during a reload.
240   * setinterfacevar option in queues.conf also now sets a variable
241      called MEMBERNAME which contains the member's name.
242   * Added 'Strategy' field to manager event QueueParams which represents
243      the queue strategy in use. 
244   * Added option to run macro when a queue member is connected to a caller, 
245      see queues.conf.sample for details.
246   * app_queue now has a 'loose' option which is almost exactly like 'strict' except it
247      does not count paused queue members as unavailable.
248   * Added min-announce-frequency option to queues.conf which allows you to control the
249      minimum amount of time between queue announcements for use when the caller's queue
250      position changes frequently.
251   * Added additional information to EXITWITHTIMEOUT and EXITWITHKEY events in the
252      queue log.
253   * Added ability for non-realtime queues to have realtime members
254   * Added the "linear" strategy to queues.
255   * Added the "wrandom" strategy to queues.
256   * Added new channel variable QUEUE_MIN_PENALTY
257   * QUEUE_MAX_PENALTY and QUEUE_MIN_PENALTY may be adjusted in mid-call by defining
258      rules in queuerules.conf. See configs/queuerules.conf.sample for details
259
260 MeetMe Changes
261 --------------
262   * The 'o' option to provide an optimization has been removed and its functionality 
263      has been enabled by default.
264   * When a conference is created, the UNIQUEID of the channel that caused it to be
265      created is stored.  Then, every channel that joins the conference will have the
266      MEETMEUNIQUEID channel variable set with this ID.  This can be used to relate
267      callers that come and go from long standing conferences.
268   * Added a new application, MeetMeChannelAdmin, which is similar to MeetMeAdmin,
269      except it does operations on a channel by name, instead of number in a conference.
270      This is a very useful feature in combination with the 'X' option to ChanSpy.
271   * Added 'C' option to Meetme which causes a caller to continue in the dialplan
272      when kicked out.
273   * Added new RealTime functionality to provide support for scheduled conferencing.
274      This includes optional messages to the caller if they attempt to join before
275      the schedule start time, or to allow the caller to join the conference early.
276      Also included is optional support for limiting the number of callers per
277      RealTime conference.
278   * Added the S() and L() options to the MeetMe application.  These are pretty
279      much identical to the S() and L() options to Dial().  They let you set
280      timeouts for the conference, as well as have warning sounds played to
281      let the caller know how much time is left, and when it is running out.
282   * Added the ability to do "meetme concise" with the "meetme" CLI command.
283      This extends the concise capabilities of this CLI command to include
284      listing all conferences, instead of an addition to the other sub commands
285      for the "meetme" command.
286   * Added the ability to specify the music on hold class used to play into the
287      conference when there is only one member and the M option is used.
288
289 Other Dialplan Application Changes
290 ----------------------------------
291   * Argument support for Gosub application
292   * From the to-do lists: straighten out the app timeout args:
293      Wait() app now really does 0.3 seconds- was truncating arg to an int.
294      WaitExten() same as Wait().
295      Congestion() - Now takes floating pt. argument.
296      Busy() - now takes floating pt. argument.
297      Read() - timeout now can be floating pt.
298      WaitForRing() now takes floating pt timeout arg.
299      SpeechBackground() -- clarified in the docstrings that the timeout is an integer seconds.
300   * Added 's' option to Page application.
301   * Added 'E' and 'V' commands to ExternalIVR.
302   * Added 'o' and 'X' options to Chanspy.
303   * Added a new dialplan application, Bridge, which allows you to bridge the
304      calling channel to any other active channel on the system.
305   * Added the ability to specify a music on hold class to play instead of ringing
306      for the SLATrunk application.
307   * The Read application no longer exits the dialplan on error.  Instead, it sets
308      READSTATUS to ERROR, which you can catch and handle separately.
309   * Added 'm' option to Directory, which lists out names, 8 at a time, instead
310      of asking for verification of each name, one at a time.
311   * Privacy() no longer uses privacy.conf, as all options are specifyable as
312      direct options to the app.
313
314 Music On Hold Changes
315 ---------------------
316   * A new option, "digit", has been added for music on hold classes in 
317      musiconhold.conf.  If this is set for a music on hold class, a caller
318      listening to music on hold can press this digit to switch to listening
319      to this music on hold class.
320   * Support for realtime music on hold has been added.
321   * In conjunction with the realtime music on hold, a general section has
322     been added to musiconhold.conf, its sole variable is cachertclasses. If this
323         is set, then music on hold classes found in realtime will be cached in memory.
324
325 AEL Changes
326 -----------
327   * AEL upgraded to use the Gosub with Arguments instead
328      of Macro application, to hopefully reduce the problems
329      seen with the artificially low stack ceiling that 
330      Macro bumps into. Macros can only call other Macros
331      to a depth of 7. Tests run using gosub, show depths
332      limited only by virtual memory. A small test demonstrated
333      recursive call depths of 100,000 without problems.
334      -- in addition to this, all apps that allowed a macro
335      to be called, as in Dial, queues, etc, are now allowing
336      a gosub call in similar fashion.
337   * AEL now generates LOCAL(argname) declarations when it
338      Set()'s the each arg name to the value of ${ARG1}, ${ARG2),
339      etc. That makes the arguments local in scope. The user
340      can define their own local variables in macros, now,
341      by saying "local myvar=someval;"  or using Set() in this
342      fashion:  Set(LOCAL(myvar)=someval);  ("local" is now
343      an AEL keyword).
344   * utils/conf2ael introduced. Will convert an extensions.conf
345     file into extensions.ael. Very crude and unfinished, but 
346     will be improved as time goes by. Should be useful for a
347     first pass at conversion.
348   * aelparse will now read extensions.conf to see if a referenced
349     macro or context is there before issueing a warning.
350
351 Call Features (res_features) Changes
352 ------------------------------------
353   * Added the parkedcalltransfers option to features.conf
354   * The built-in method for doing attended transfers has been updated to
355      include some new options that allow you to have the transferee sent
356      back to the person that did the transfer if the transfer is not successful.
357      See the options "atxferdropcall", "atxferloopdelay", and "atxfercallbackretries"
358      in features.conf.sample.
359   * Added support for configuring named groups of custom call features in
360      features.conf.  This means that features can be written a single time, and
361      then mapped into groups of features for different key mappings or easier
362      access control.
363   * Updated the ParkedCall application to allow you to not specify a parking
364      extension.  If you don't specify a parking space to pick up, it will grab
365      the first one available.
366
367 Language Support Changes
368 ------------------------
369   * Brazilian Portuguese (pt-BR) in VM, and say.c was added
370   * Added support for the Hungarian language for saying numbers, dates, and times.
371
372 AGI Changes
373 -----------
374   * Added SPEECH commands for speech recognition. A complete listing can be found
375      using agi show.
376
377 Logger changes
378 --------------
379   * Added rotatestrategy option to logger.conf, along with two new options:
380      "timestamp" which will use the time to name the logger files instead of
381      sequence number; and "rotate", which rotates the names of the logfiles,
382      similar to the way syslog rotates files.
383   * Added exec_after_rotate option to logger.conf, which allows a system
384      command to be run after rotation.  This is primarily useful with
385      rotatestrategry=rotate, to allow a limit on the number of logfiles kept
386      and to ensure that the oldest log file gets deleted.
387   * Added realtime support for the queue log
388
389 Miscellaneous 
390 -------------
391   * Ability to use libcap to set high ToS bits when non-root
392      on Linux. If configure is unable to find libcap then you
393      can use --with-cap to specify the path.
394   * Added maxfiles option to options section of asterisk.conf which allows you to specify
395      what Asterisk should set as the maximum number of open files when it loads.
396   * Added the jittertargetextra configuration option.
397   * Added a new CDR module, cdr_sqlite3_custom.
398   * The cdr_manager module has a [mappings] feature, like cdr_custom,
399     to add fields to the manager event from the CDR variables.
400   * Added a new realtime configuration module, res_config_sqlite
401   * Added support for setting the CoS for VLAN traffic (802.1p).  See the sample
402      configuration files for the IP channel drivers.  The new option is "cos".
403      This information is also documented in doc/qos.tex, or the IP Quality of Service
404      section of asterisk.pdf.
405   * When originating a call using AMI or pbx_spool that fails the reason for failure
406      will now be available in the failed extension using the REASON dialplan variable.
407   * Added support for reading the TOUCH_MONITOR_PREFIX channel variable.
408      It allows you to configure a prefix for auto-monitor recordings.
409   * Added support for writing and running your dialplan in lua.  See
410      configs/extensions.lua.sample for examples of how to do this.
411   * A new extension pattern matching algorithm, based on a trie, is introduced
412     here, that could noticeably speed up mid-sized to large dialplans.
413     It is NOT used by default, as duplicating the behaviour of the old pattern
414     matcher is still under development. A config file option, in extensions.conf,
415     in the [general] section, called "extenpatternmatchingnew", is by default
416     set to false; setting that to true will force the use of the new algorithm.
417     Also, the cli commands "dialplan set extenpatternmatchingnew true/false" can
418     be used to switch the algorithms at run time.
419   * A new option when starting a remote asterisk (rasterisk, asterisk -r) for
420     specifying which socket to use to connect to the running Asterisk daemon
421     (-s)
422   * Added a new dialplan function, DIALPLAN_EXISTS(), which allows you to check for
423      the existence of a dialplan target.