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