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