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